Kaffa

Kaffa's Faded Fadeless Abstraction

reStructureText 九个实用语法

Markdown 各方实现经常不一致,累觉无爱,相比来说 reStructureText 更严谨丰富,换句话说就是更复杂。但作为 Pelican 引擎的主动力,我对语言技巧的基本态度是用最熟悉基础的即可写出文章,综合比较,我放弃了 md 转回了 rst。

本文说的实用主义,即达到能写文章即可的程度。不看 rst 所有的语法是什么能做什么,而是看写文章用到 rst 哪些语法。

语法指南

本文是 reStructureText 实用语法指南,其中列出最常用的九个语法,用来写博客足矣。其余更多细节,请查阅官方指南。

一、文本样式:

*斜体*  **粗体**  ``段内标记``

斜体 粗体 段内标记

二、标题:

================================
reStructureText 实用语法指南
================================

第 1 章 标题
===============

第 1.1 节 标题
-----------------

第 1.1.1 小节 标题
~~~~~~~~~~~~~~~~~~~~~~

第 1.2 节 标题
-----------------

第 2 章 标题
===============

reStructureText 实用语法指南

第 1 章 标题

第 2 章 标题

此处完整效果预览请在VSCode中试,如遇到问题,参阅我另一篇 用 VSCode 预览 reStructureText 文件

三、段落:

段落是由空行分割的文字。

这是另一个段落。

段落是由空行分割的文字。

这是另一个段落。

四、术语表和列表

术语表:

术语一
    术语解释,需要缩进。

    甚至可以有多个段落。

术语二
    描述
术语一

术语解释,需要缩进。

甚至可以有多个段落。

术语二
描述

无序列表:

* 这是一个无序列表
* 它含有两项,第二
  项占两行
  • 这是一个无序列表
  • 它含有两项,第二 项占两行

有序列表:

1. 这是一个有序列表
2. 它也有两项
  1. 这是一个有序列表
  2. 它也有两项

多级列表:

* 这是
* 一个列表

    * 含一个缩进列表子项
    * 和另一个子项

* 这里是父项的继续
  • 这是

  • 一个列表

    • 含一个缩进列表子项
    • 和另一个子项
  • 这里是父项的继续

五、代码:

五、代码::

    # PEP 20 -- The Zen of Python
    import this

显示为:

# PEP 20 -- The Zen of Python
import this

六、表格:

=====  =====  =======
A      B      A and B
=====  =====  =======
False  False  False
True   False  False
False  True   False
True   True   True
=====  =====  =======
A B A and B
False False False
True False False
False True False
True True True

更复杂的格式:

+------------------------+------------+----------+----------+
| 第一行第一列           | 第二列     | 第三列   | 第四列   |
| 标题行第二列           |            |          |          |
+========================+============+==========+==========+
| 第二行第一列           | 第二列     | 第三列   | 第四列   |
+------------------------+------------+----------+----------+
| 第三行第一列           | ...        | ...      |          |
+------------------------+------------+----------+----------+
第一行第一列 标题行第二列 第二列 第三列 第四列
第二行第一列 第二列 第三列 第四列
第三行第一列 ... ...  

七、注释:

..
    这个缩进
    是一个注释。

    同级依然是注释

上方 rst 源文件中含有一段注释。

八、超链接:

`链接 <https://kaffa.im/>`_

这段含有一个`链接`_。

.. _`链接`: https://kaffa.im/

这是链接

这段含有一个 链接

九、图片:

.. image:: https://kaffa.im/img/reward.png
    :alt: 赞赏码

加上属性:

.. image:: kaffa.png
    :height: 100
    :width: 200
    :scale: 50
    :alt: 图片的替换文字
赞赏码