Markdown 编写规范
- 说明
- 规则

Markdown 编写规范

“参考”与“借鉴”自吴多益大神的百度 fex-team/styleguide 项目非原创，转载者注明请出处，官方设定其基于： Creative Commons Attribution 4.0 International License，仅供参考，相关设计非常有远见。

此为前端开发团队遵循和约定的Markdown 编写规范，意在提高文档的可读性。

说明

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

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

规则

后缀必须「MUST」使用 .md。
文件名必须「MUST」使用小写，多个单词之间使用-风格。
编码必须「MUST」用 UTF-8。
章节必须「MUST」以 ## 开始，而不是 #。
文档标题的推荐写法「MUST」。
若每段中文段落内没有英语单词或空格，则尽量不要换行。换行选在文中原本是空格的位置。
```
  Markdown 编写规范
  ==========================
```

章节标题的写法「MUST」。

  // bad
  ##章节1
  // bad
  ## 章节1 ##
  // good
  ## 章节1

标题和内容间必须「MUST」有空行。

  // bad
  ## 章节1
  内容
  ## 章节2
  // good
  ## 章节1
  内容
  ## 章节2

代码段的必须「MUST」使用 Fenced code blocks 风格，具体写法请参考本文档源码。除了列表中的代码段：Keep in mind that, within lists, you must indent non-fenced code blocks eight spaces to render them properly.

表格的写法「SHOULD」，无需对齐每一行，参考 GFM。

  第一栏表头    | 第二栏表头
  ------------- | -------------
  Content Cell  | Content Cell
  Content Cell  | Content Cell
  | 左对齐        | 居中对齐        | 右对齐|
  | :------------ |:---------------:| -----:|
  | col 3 is      | some wordy text | $1600 |
  | col 2 is      | centered        |   $12 |
  | zebra stripes | are neat        |    $1 |

中英文混排的写法「SHOULD」。
- 英文和数字使用半角字符
- 中文文字之间不加空格
- 中文文字与英文、阿拉伯数字及 @ # $ % ^ & * . ( ) 等符号之间加空格
- 中文标点之间不加空格
- 中文标点与前后字符（无论全角或半角）之间不加空格
- 如果括号内有中文，则使用中文括号
- 如果括号中的内容全部都是英文，则使用半角英文括号
- 当半角符号 / 表示「或者」之意时，与前后的字符之间均不加空格
中文符号的写法「RECOMMENDED」。
- 用直角引号（「」）代替双引号（“”），不同输入法的具体设置方法请参考这里
- 其它可以参考知乎规范
表达方式，应当「SHOULD」遵循《The Element of Style》。
- 使段落成为文章的单元：一个段落只表达一个主题
- 通常在每一段落开始要点题，在段落结尾要扣题
- 使用主动语态
- 陈述句中使用肯定说法
- 删除不必要的词
- 避免连续使用松散的句子
- 使用相同的结构表达并列的意思
- 将相关的词放在一起
- 在总结中，要用同一种时态（这里指英文中的时态，中文不适用，所以可以不理会）
- 将强调的词放在句末