Markdown 编写规范

    文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL
    NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在 中有说明。

    还未定稿,对规范中提及的点有不赞同的欢迎提出 issues(请添加 标签)讨论。

    • 后缀必须「MUST」使用 .md
    • 文件名必须「MUST」使用小写,多个单词之间使用分隔。
    • 文件编码必须「MUST」用 UTF-8。
    • 章节标题必须「MUST」以 ## 开始,而不是 。
    • 章节标题必须「MUST」在 # 后加一个空格,且后面没有 。

    • 章节标题和内容间必须「MUST」有一个空行。

    • 表格的写法应该「SHOULD」参考 ,如下所示:

      • 用直角引号(「」)代替双引号(“”),不同输入法的具体设置方法请参考这里
      • 省略号使用「……」,而「。。。」仅用于表示停顿
    • 表达方式,应当「SHOULD」遵循《The Element of Style》:

      • 使段落成为文章的单元:一个段落只表达一个主题
      • 通常在每一段落开始要点题,在段落结尾要扣题
      • 使用主动语态
      • 陈述句中使用肯定说法
      • 删除不必要的词
      • 避免连续使用松散的句子
      • 使用相同的结构表达并列的意思
      • 将相关的词放在一起
      • 在总结中,要用同一种时态(这里指英文中的时态,中文不适用,所以可以不理会)
      • 将强调的词放在句末
    • Google 后来也出了 ,很多和这里是一样的,但也增加了一些约定,可以参考