Markdown 转 API 文档

关于 Markdown 转文档

把接口说明、请求示例和响应片段从 Markdown 草稿整理成更适合发布的结构化输出。

为什么要把 Markdown 转成 API 文档？

Markdown 适合快速记录，但在发布、审阅和复用时，结构统一的文档更容易维护。尤其是接口标题、参数说明和代码块，统一格式能减少后续返工。

主要特点

• 支持标题、列表、段落和代码块转换。
• 自动提取文档大纲，方便检查章节结构。
• 同时提供 HTML 输出和可视化预览。
• 本地执行，适合内部 API 草稿和未公开文档。

使用方式

1. 粘贴包含接口说明和示例的 Markdown 内容。
2. 检查大纲和生成后的 HTML。
3. 复制结果到文档系统，或继续调整 Markdown 后重新生成。