使用 Markdown

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

局限性

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

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

包括 Snippets

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