使用 Markdown

本节描述了使用 Markdown 的方面,这些方面与 Spring REST Docs 特别相关。spring-doc.cadn.net.cn

局限性

Markdown 最初是为网络写作的人设计的,因此,它不像 Asciidoctor 那样适合编写文档。 通常,这些限制可以通过使用另一个基于 Markdown 构建的工具来克服。spring-doc.cadn.net.cn

Markdown 没有对表的官方支持。 Spring REST Docs 的默认 Markdown 代码片段模板使用 Markdown Extra 的表格格式spring-doc.cadn.net.cn

包括片段

Markdown 没有内置支持将一个 Markdown 文件包含在另一个文件中。 要在文档中包含生成的 Markdown 片段,您应该使用支持此功能的其他工具。 一个特别适合记录 API 的示例是 Slatespring-doc.cadn.net.cn