reStructuredText 简称 rst,是一种轻量级的标记语言,常用于编写文档。下面介绍一些 rst 基础语法,以便于快速查阅和学习。
在 rst 中,标题由一到两个井号( # )表示,后面紧跟着标题文本。
一级标题 ========= 二级标题 ---------
无序列表使用星号( * )或加号( + ),而有序列表则使用数字后跟点号( . )。
无序列表项1 无序列表项2 + 无序列表项1 + 无序列表项2 1. 有序列表项1 2. 有序列表项2
行内链接使用方括号包围链接文本,紧接着用小括号包围 URL。
链接文本 <http://example.com>
插入图片与链接类似,使用感叹号( ! )开始,然后是方括号包围图片描述,最后是圆括号包围图片路径。
.. image:: https://source.unsplash.com/600x337/?technology :alt: 图片描述
注意:使用 Unsplash API 获取图片。
行内代码使用反引号( ` )包围代码。
在代码中使用 `if` 语句判断。
代码块使用缩进或者 .. codeblock::
指令。
.. codeblock:: python def my_function(): print("Hello, World!")
要在 rst 中创建表格,可以使用加号( + )和管道( | )字符来绘制表格的网格。第一行是表头,第二行是分隔线,接着是数据行。
+------+------+------+ | 列1 | 列2 | 列3 | +======+======+======+ | 数据1 | 数据2 | 数据3 | +------+------+------+ | 数据4 | 数据5 | 数据6 | +------+------+------+
A1: 在 rst 中,您可以通过连续使用数字和点来创建多级有序列表。
1. 一级列表项 1.1. 子列表项1 1.2. 子列表项2 1.2.1. 子子列表项1 1.2.1.1. 子子子列表项1
A2: 您可以使用 .. include::
指令来包含其他 rst 文件的内容。
.. include:: other_file.rst
这将会把 other_file.rst
文件的内容插入到当前位置。
以上是 reStructuredText 的基础语法介绍,欢迎大家掌握并使用。
谢谢观看!欢迎评论、关注、点赞和分享!