样式指南
本页提供 MOSN 文档的内容样式指南。
格式标准
- 必须使用 Markdown 格式编辑文档正文。
- 文档正文标题从二级标题开始。
- 图片使用本地图片,跟
index.md
文件放在同一个目录下,使用相对位置引用。 - 所有代码都需要指定代码语言。
- 中英文之间要加空格,如果句子末尾是英文则不需要。
- 请不要将有序列表和无序列表穿插混用,容易造成格式混乱。
- 对于直接出现的 URL 链接请使用
<URL>
包裹起来。 - 对于非通用词汇、代码中词组的引用请使用反括号包裹起来。
修改于 2022年5月11日: fix the istio-diff links (#199) (143cd05)