基于 Markdown 编写文档

Markdown 是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Swagger 文档中支持的是 GFM ,即 GitHub Flavored Markdown ,其实跟常规的 Markdown 大同小异,有需要了解的读者可以点击链接了解:https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown

在下文我们只会用到 Markdown 语法中的标题语法,读者只需要知道 # 开头的文本行会被渲染为一级标题,## 开头的则会被渲染为二级标题即可。

为描述方便,以 .md 为格式后缀的 Markdown 文件在下文简称为 md 文件。

注意:md 文件中行与行之间需要间隔一个空行,编辑的时候要注意,不然会影响解析和渲染。

results matching ""

    No results matching ""