-
在线rst编辑器:
-
英文文档:https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
-
国内资料: reStructuredText(.rst)语法规则快速入门 1, reStructuredText(.rst)语法规则快速入门2
简单总结:
-
标题: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ 连续几个分为几级标题
-
段落: 空行为一段, 缩进变成引用段落
-
列表
无序列表:* + - • ‣ ⁃
有序列表:
1arabic numerals: 1, 2, 3, ... (no upper limit). 2uppercase alphabet characters: A, B, C, ..., Z. 3lower-case alphabet characters: a, b, c, ..., z. 4uppercase Roman numerals: I, II, III, IV, ..., MMMMCMXCIX (4999). 5lowercase Roman numerals: i, ii, iii, iv, ..., mmmmcmxcix (4999).
如果你不想使用这些,在你标明第一个条目的序号字符后,第二个开始你还可以使用”#”号来让reStructuredText自动生成需要的序号。
定义列表
字段列表
选项列表
-
表格:
网格表: - = | +
-” 用来分隔行, “=“ 用来分隔表头和表体行,”|” 用来分隔列,而”+”用来表示行和列相交的节点
简单表格: = -
1 2基本形式 3======== 4 5`下面这种是最简单的表格形式,当然你也可以去掉表头展示。` 6 7===== ===== ======= 8 A B A and B 9===== ===== ======= 10False False False 11True False False 12False True False 13True True True 14===== ===== ======= 15 16表内嵌入 17======== 18 19`下面这种简单表内有列表` 20 21===== ===== 22col 1 col 2 23===== ===== 241 Second column of row 1. 252 Second column of row 2. 26 Second line of paragraph. 273 - Second column of row 3. 28 29 - Second item in bullet 30 list (row 3, column 2). 31\ Row 4; column 1 will be empty. 32===== =====
-
块:
文字块: 前面两冒号+空行, 块内内容要有缩进。
-
样式:
1.. Strong Emphasis 2 3This is **Strong Text**. HTML tag is strong.粗体 4 5.. Italic, Emphasis 6 7This is *Emphasis* Text.这个HTML使用em, 斜体 8 9.. Interpreted Text 10 11This is `Interpreted Text`. 注意,这个HTML一般用<cite>表示 12 13.. Inline Literals 14 15This is ``Inline Literals``. HTML tag is <tt>. 等宽字体. 16 17 18 19我这里是一个 链接_. 20 21.. _链接: http://blog.useasp.net 22 23这里同样是一个 `链接<http://blog.useasp.net>`_,不需要特别设置。