使用 Markdown

本节描述了与 Spring REST Docs 特别相关的 Markdown 使用方面。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 文件。 若要在文档中包含生成的 Markdown 片段,您应使用支持此功能的额外工具。 一个特别适合用于记录 API 的示例是 Slatespring-doc.cadn.net.cn