docbox

开源的REST API文档生成工具。把结构化的Markdown文件生成带导航、固定链接和示例的双栏文档页面。

分享到 X许可证: ISC

概述

Docbox 是用于编写 REST API 文档的开源系统。你只需编写结构化的 Markdown,它就会生成两栏站点:左侧是说明,右侧是示例,并带有导航和永久链接。它是使用 remark 解析 Markdown 的 React 应用。源文件不含展示代码,构建步骤会为发布做好准备。

主要特点

  • 把结构化 Markdown 生成两栏文档站点
  • 自动生成导航和永久链接
  • 测试可检查失效链接、无效示例和结构问题
  • 提取文档中的 JavaScript 示例并用 eslint 检查

适用场景

适合想用纯 Markdown 维护 API 文档,并通过自动检查保持一致性的团队。

上游仓库
mapillary/docbox
GitHub 上的 fork
Guo-astro/docbox
上游 Star 数
1
分类
文档、媒体与内容
许可证
ISC
Fork 时间
2020-12-06
同步状态
已同步上次同步 2026-09-29