rst写作规范

文档结构

  1. 模块化上要求主题分割明显，层次分明
  2. 布局上要求重要的、常用的、概括的、介绍性的放在前面，具体的、次要的、附属性的放在后面

写作格式

  1. 文档的一级标题使用，为文档标题
******
source
******
  1. 文档的二级标题使用，为章节标题
======
Title1
======
  1. 文档的三级标题使用，为子章节标题
Title3
------
  1. 章节与章节之间要求空三行
  2. 子章节与子章节之间要求空一行
  3. 标题与内容之间要求空一行
  4. 章节与子章节中的内容如果要用列表表示则使用数字列表
  5. 子列表使用 x.y 格式，并且使用 `` | `` 进行强制换行，并且与上下文之间各空一行
  6. 三级子列表则使用 (num) 格式
  7. 如果列表包含的内容中有需要空行的，那么下一个列表序号使用数字而非 #
  8. 缩进使用4个空格，不使用Tab
  9. 使用代码段的时候代码段与上下文之间各空一行

想到了再补充...

注意事项

  1. 写作时尽量使用插件提供的快捷方式而非自己去写格式
  2. sublime主题使用 Dawn
  3. 使用列表的时候添加代码或者其他任何形式的引用不能直接在列表后添加 :: 来进行换行，必须要空一行之后再使用这个
  4. 要想防止加粗直接在末尾加一个空格就好了
  5. 列表项中要换行描述详细内容的话则需要使用空格进行缩进