ReST 文档结构语法

3.1. ReST 文档结构语法#

rst的基础语法和markdown差不多，

可以使用这个在线的rst编辑器了解相关语法：rst在线编辑器

3.1.1. 标题语法#

章节标记 Section Structure#

任意可打印的7个bit的ASCII码字符都可以作为章节标识符，它们是

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

不过有些可能会看起来比较奇怪，因此推荐使用其中的

= - ` : . ' " ~ ^ _ * + #

  • 在reStructureText中未明确各个章节标识符层级的顺序，它按照标识符在书写文本中的顺序来指定标识符指示的标题层级 。

  • 在标题上下，使用两行标识符；和只在标题下使用一行标识符。效果是一样的。

  • 标题标识符的数量至少要和标题文本等长

  • 建议定义如下标题标识符层级（从高到低）为 = - , . *

可以使用如下标准定义各级标题

一级标题
==========
二级标题
----------
三级标题
,,,,,,,,,
四级标题
............
五级标题
*************

段落 Paragraphs#

段落一般隶属于某个章节中，是一块左对齐并且没有其他元素体标记的块。 在.rst文件中，段落和其他内容的分割是靠 空行 来完成

如果段落相较于其他的段落有 缩进**（这段缩进了4个空格），reStructuredText会解析为 **引用段落 ，样式上有些不同。

推荐用法#

使用相同的符号表示。并无前后、级别的特殊要求，但一般在篇文档中，使用下面方式表达，一般不超过3级标题：

==============================
一级标题
==============================

二级标题
==============================

三级标题
------------------

3.1.2. Transitions#

转换分隔用于段与段之间的分隔，相当于html中的 <hr> ，就是跨屏的一个横线。

使用4个及以上的标点符号(推荐使用短横 - )就可以生成，同样需要前后空行；另外，不能连续出现 ，也不能在文档结尾使用。

示例如下:

前后需要空行

,,,,,,,,

使用标点符号

.............

不能连续出现

---------------

不能在结尾使用

效果如下：

前后需要空行

使用标点符号

不能连续出现

不能在结尾使用

目录