1. RST模板¶
1.1. 二级标题¶
注解
注解 - 标题级别和下划线无对应,文档中保持一致就好。 - reST标题可用下列符号标记: # * = - ^ ~ ` : . _ + ” 等。
1.2. 字体¶
两个连续反引号嵌入代码,如: git status 。
Got GitHub by Jiang Xin.
这是 粗体 ,这是 斜体 。
不留白的粗体和斜体效果
删除线 效果
不留白的删除线效果
下划线 效果
不留白的下划线效果
- Water: H2O
- E = mc2
标记符号前后空白用反斜线消除
1.3. 段落¶
第一段内容。
第二段和第一段间有一空行。
一个回车不分段, 本行续上行。
保持换行符,
本行不续行。
用新定义的role插入换行,
本行不再续行。
注释¶
- git
- Simple and beautiful.
- hg
- Another DVCS.
- subversion
VCS with many constrains.
Why not Git?
分割线¶
四条短线或以上显示为分隔线。
1.4. 列表¶
无序列表¶
- 星号、减号、加号开始列表。
- 列表层级和缩进有关。
- 和具体符号无关。
- 列表层级和缩进有关。
- 返回一级列表。
有序列表¶
- 数字和点是一种编号方式。
- 大写字母编号。
- 小写字母编号。
- 大写字母编号。
- 继续一级列表。
- 大写罗马编号。
- 小写罗马编号。
- 大写罗马编号。
列表续行、段落和代码块¶
列表项可以折行, 对齐则自动续行。
列表项可包含多个段落。
空行开始的新段落, 新段落要和列表项内容对齐。
列表下的代码段注意对齐即可。
$ printf "Hello, world.\n"
1.5. 链接¶
超链接¶
- 网址 http://github.com/
- 邮件 me@foo.bar
- 访问 Google 。
- 上面已定义,直接引用 google 链接。
- 链接地址在后面定义,如: GitHub 。
- 反引号括起多个单词的链接。如 my blog 。