Markdown 中文排版指南

中文排版指南及 Markdown + Vim 工具

整理自如下指南：
中文排版指南
Markdown 中文技术文档的写作规范

工具
「盘古之白」

标题

• 文章标题使用一级标题
• 文章顶层标题使用二级标题
• 每个小节的标题使用三级标题
• 进一步分层组织时使用四级标题
• 尽量少用五级标题和六级标题，考虑用有序列表和无序列表代替
• 标题要避免孤立编号（即同级标题只有一个）
• 下级标题不重复上一级标题的内容

全角与半角

• 使用全角中文标点
• 遇到完整的英文整句、特殊名词，其內容使用半角标点

空格

• 中英文之间需要增加空格

  在 LeanCloud 上，数据存储是围绕 AVObject 进行的。

• 中文与数字之间需要增加空格

  今天出去买菜花了 5000 元。

• 数字与单位之间无需增加空格

  我家的光纤入户宽带有 10Gbps，SSD 一共有 10TB。
  今天是 233° 的高温。

• 全角标点与其他字符之间不加空格

  刚刚买了一部 iPhone，好开心！

名词

• 专有名词使用正确的大小写

  我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook, Inc.。

• 不要使用不地道的缩写

  我们需要一位熟悉 JavaScript、HTML5，至少理解一种框架（如 Backbone.js、AngularJS、React 等）的前端开发者。

• 在提到了 专有名词和特殊名词 时、或者需要 着重强调的词汇 时，在前后添加 半角空格 分词，或者使用 行内代码块
• 第一次出现英文词汇时，在括号中给出中文标注。此后再次出现时，直接使用英文缩写即可

  IOC（International Olympic Committee，国际奥林匹克委员会）。这样定义后，便可以直接使用“IOC”了。

文本

• 正文段落之间用一个空行来分隔
• 需要强调某处内容时使用粗体
• 中文排版中不使用斜体
• 英文排版中可用斜体表达强调，或表示书名、题目

标点符号

• 不重复使用标点符号
• 在中文输入法状态下，可使用「Shift + 6」输入省略号

  ……

• 在中文输入法状态下，可使用「Shift + -」输入破折号

  破折号，标示语段中某些成分的注释、补充说明或语音、意义的变化。——《标点符号用法》

• 数字使用半角字符

写作规范

• 避免使用长句
• 尽量使用简单句和并列句
• 尽量不使用被动语态，改为使用主动语态
• 不使用非正式的语言风格
• 用对“的”、“地”、“得”

  她露出了开心的笑容。（形容词＋的＋名词）
  她开心地笑了。（副词＋地＋动词）
  她笑得很开心。（动词＋得＋副词）

• 名词前不要使用过多的形容词
• 尽量使用肯定句表达，不使用否定句表达
• 避免使用双重否定句