Markdown 文档

Apidog 不仅限于 API 文档，还允许你将丰富的 Markdown 内容直接集成到文档中。这使你能够创建全面的用户指南，将 API 参考与说明文本、教程和示例无缝结合。Markdown 文档可以添加到多个层级，并与 API 文档一起显示，从而提供完整的文档体验。

独立 Markdown 文档

通过点击加号（+）按钮，将独立的 Markdown 文档添加到任意端点文件夹。在编辑器中编写 Markdown 内容，并在右侧窗格中即时预览渲染结果。

Markdown 也支持用于每个端点的描述字段。你在此处添加的任何 Markdown 都会在 API 文档中渲染为格式化文本，使你的端点描述更加清晰且具有视觉吸引力。

在文件夹级别添加 Markdown 内容，以提供上下文和概览信息。当读者在文档中点击文件夹名称时，他们会看到该文件夹的 Markdown 内容。如果没有文件夹级 Markdown，点击文件夹只会展开它以显示其内容。

添加文件夹级 Markdown：

Apidog Markdown 支持多种扩展样式，包括 Card、Accordion、Frame 等。这些自定义组件使你能够创建更丰富、更具交互性的文档体验。

通过点击 Markdown 编辑器中的 Insert 按钮，可以轻松插入这些样式，该按钮会提供一组可用元素。

了解更多

了解更多关于 Apidog Markdown 的信息。