Markdown 编写规范

说明 文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在 RFC2119 中有说明。 还未定稿,对规范中提及的点有不赞同的欢迎提出 issues(请添加 markdown 标签)讨论。 规则 后缀必须「MUST」使用 .md。 文件名必须「MUST」使用小写,多个单词之间使用-分隔。 文件编码必须「MUST」用 UTF-8。 文档标题应该「SHOULD」这样写。 Markdown 编写规范 ========================== 章节标题必须「MUST」以 ## 开始,而不是 #。 章节标题必须「MUST」在 # 后加一个空格,且后面没有 #。 // bad ##章节1 // bad ## 章节1 ## // good ## 章节1 章节标题和内容间必须「MUST」有一个空行。 // bad ## 章节1 内容 ## 章节2 // good ## 章节1 内容 ## 章节2 代码段的必须「MUST」使用 Fenced code blocks 风格,如下所示: ``` console.log(""); ``` 表格的写法应该「SHOULD」参考 GFM,如下所示: First Header | Second Header ------------- | ------------- Content Cell | Content Cell Content Cell | Content Cell | Left-Aligned | Center Aligned | Right Aligned | | :------------ |:---------------:| -----:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | 中英文混排应该「SHOULD」采用如下规则:...

September 24, 2024 · 2 min · 223 words · Similarityoung