打造个人笔记—02案例之rst语法笔记

简介

本笔记旨在介绍并归纳 reStructuredText（简称 rst）的语法，以便于快速查阅和学习，rst 是一种易于阅读、用于编写文档的轻量级标记语言。

基础语法

标题

在 rst 中，标题由一到两个井号(#)表示，后面紧跟着标题文本。

一级标题
二级标题
三级标题
四级标题
五级标题
六级标题

列表

无序列表使用星号(*)或加号(+)，而有序列表则使用数字后跟点号(.)。

无序列表项1
无序列表项2
+ 无序列表项1
+ 无序列表项2
1、有序列表项1
2、有序列表项2

链接

行内链接使用方括号包围链接文本，紧接着用小括号包围 URL。

链接文本 <http://example.com>_

图片

插入图片与链接类似，使用感叹号!开始，然后是方括号包围图片描述，最后是圆括号包围图片路径。

.. image:: /path/to/image.png
   :alt: 图片描述

代码块

行内代码使用反引号` “包围代码。

代码块使用缩进或者 `.. codeblock::` 指令。

.. codeblock:: python
    def my_function():
        print("Hello, World!")

表格

要在 rst 中创建表格，可以使用 + 和 字符来绘制表格的网格。

++++
| 列1 | 列标题2    | 列3   |
++++
| 单元格1 | 单元格2    | 单元格3 |
++++

相关问题与解答

Q1: 如何在 rst 中创建多级有序列表？

A1: 在 rst 中，您可以通过连续使用数字和点来创建多级有序列表。

1、一级列表项
   1.1. 子列表项1
   1.2. 子列表项2
   1.2.1. 子子列表项1
       1.2.1.1. 子子子列表项1

Q2: 怎样在 rst 文档中包含其他 rst 文件？

A2: 您可以使用 .. include:: 指令来包含其他 rst 文件的内容。

.. include:: other_file.rst

这将会把 other_file.rst 文件的内容插入到当前位置。