1. RST模板

1.1. 二级标题

注解

注解 - 标题级别和下划线无对应,文档中保持一致就好。 - reST标题可用下列符号标记: # * = - ^ ~ ` : . _ + ” 等。

三级标题

四级标题

五级标题
六级标题

1.2. 字体

两个连续反引号嵌入代码,如: git status

Got GitHub by Jiang Xin.

这是 粗体 ,这是 斜体

不留白的粗体斜体效果

删除线 效果

不留白的删除线效果

下划线 效果

不留白的下划线效果

  • Water: H2O
  • E = mc2

标记符号前后空白用反斜线消除

1.3. 段落

第一段内容。

第二段和第一段间有一空行。

一个回车不分段, 本行续上行。

保持换行符,
本行不续行。

用新定义的role插入换行,
本行不再续行。

段落缩进

邮件体段落缩进:

> 第一级段落缩进。 > > > 第二级段落缩进。 > > 返回一级段落缩进。

代码块

双冒号后缩进为代码块。

$ printf "Hello, world.\n"

还可声明语言类型实现语法加亮。

$ printf "Hello, world.\n"

注释

git
Simple and beautiful.
hg
Another DVCS.
subversion

VCS with many constrains.

Why not Git?

分割线

四条短线或以上显示为分隔线。


1.4. 列表

无序列表

  • 星号、减号、加号开始列表。
    • 列表层级和缩进有关。
      • 和具体符号无关。
  • 返回一级列表。

有序列表

  1. 数字和点是一种编号方式。
    1. 大写字母编号。
      1. 小写字母编号。
  2. 继续一级列表。
    1. 大写罗马编号。
      1. 小写罗马编号。

列表续行、段落和代码块

  1. 列表项可以折行, 对齐则自动续行。

  2. 列表项可包含多个段落。

    空行开始的新段落, 新段落要和列表项内容对齐。

  3. 列表下的代码段注意对齐即可。

    $ printf "Hello, world.\n"
    

1.5. 链接

超链接

内部跳转

../_images/github.jpg

内部跳转图例

上面定义的位置,可以:

1.6. 表格

示例表格
head1 head2 head3
rowspan cell cell
  • colspan
  • another line

1.7. 图片

../_images/github.jpg

图:GitHub Octocat

  • GitHub Logo: octocat

  • 带链接的图片: imglink

  • 下图向右浮动。
    ../_images/github.jpg

1.8. 其他

转义

反斜线作为转义字符,禁止对后面 *字符* 做语法解析。

脚注

reST脚注的多种表示法:

  • 脚注即可以手动分配数字 [1] , 也可以使用井号自动分配 [2]
  • 自动分配脚注 [3] 也可以用 添加标签形式 [3] 多次引用。
  • 还支持用星号嵌入符号式脚注, 如这个 [*] 和 这个 [†]
  • 使用单词做标识亦可 [CIT2012]
[1]数字编号脚注。
[2]井号自动编号。
[3](1, 2) 井号添加标签以便多次引用。
[*]星号自动用符号做脚注标记。
[†]星号自动用符号做脚注标记。
[CIT2012]单词或其他规定格式。