reStructuredText 是一种扩展名为.rst的纯文本文件,通过特定的解释器,能够将文本中的内容输出为特定的格式
1. 章节标题
章节头部由下线(也可有上线)和包含标点的标题组合创建,其中下线要至少等于标准文本的长度
可以表示标题的符号有 =,- ,+,*,#,`,:,',",~,^,_,<,>
对于相同的符号,有上标是一级标题,没有上标是二级标题
标题最多分六级,可以*组合使用
全加上标或者全不加上标,使用不同的6个符号的标题依次排列,则会依次生成的标题为H1-H6
一级标题
=================
二级标题
-----------------------
三级标题
+++++++++++++
四级标题
_________________
五级标题
******************
六级标题
##############
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
2. 段落
段落是被空行分割的文字片段,左侧必须对齐(没有空格,或者相同的空格)
缩进的段落没视为引文
这是一个段落 这是另一个段落 这是一段引文
这是一个段落
这是另一个段落
这是一段引文
3. 列表
符号列表
符号列表使用 -,+,*
下级列表需要有缩进空格
- 列表1
- 列表2
- 下级列表1
- 下级列表2
- 列表1
- 列表2
- 下级列表1
- 下级列表2
顺序列表
可以使用的顺序序号有:
- 阿拉伯数字:1,2,3 ...
- 大写字母A-Z
- 小写字母a-z
- 大写罗马数字:I, II, III, IV,V...
- 小写罗马数字:i,ii,iii,iv,v...
可以为序号添加前缀和后缀
- .后缀:"1.","A.","a."
- ()抱起来:"(1)","(A)","(a)"
- )后缀:"1)","A)","a)"
顺序列表可以借助 # 自动生成顺序
. 列表1
. 列表2 (A) 列表A
(B) 列表2
- 列表1
- 列表2
(A) 列表A
(B) 列表B
4. 文本代码
文本代码都是以引用的形式展示的
.. code:: 这是一段引用的文本,文字将显示在一个方格框里面
这是一段引用的文本,文字将显示在一个方格框里面
5. 粗体,斜体
*斜体* **粗体**
斜体
粗体
6. 超链接
rst文件会为网址自动生成超链接
https://github.com/xxpasswd
这是我的python学习记录,请参考 `python web 学习 <https://python-web-study.readthedocs.io/zh_CN/latest/>`_。
这是我的python学习记录,请参考 python web 学习
7. 引用
图片引用, 将image后面的地址换为图片的地址
|web| .. |web| image:: web_deploy.png
总结了一些写rst文档常用的标签,基本能够满足日常写作的需求了