Working with Markdown

This section describes the aspects of working with Markdown that are particularly relevant to Spring REST Docs.spring-doc.cn

Limitations

Markdown was originally designed for people writing for the web and, as such, is not as well-suited to writing documentation as Asciidoctor. Typically, these limitations are overcome by using another tool that builds on top of Markdown.spring-doc.cn

Markdown has no official support for tables. Spring REST Docs' default Markdown snippet templates use Markdown Extra’s table format.spring-doc.cn

Including Snippets

Markdown has no built-in support for including one Markdown file in another. To include the generated snippets of Markdown in your documentation, you should use an additional tool that supports this functionality.spring-doc.cn