Rest文本块

3.5. Rest文本块#

3.5.1. 文字块 Literal Blocks#

文字块就是一段文字信息，指示符为连续两个冒号 :: ，支持文字块的嵌套。

文字块支持三种形式的语法(完全等价)

  1. 起始新行，后接空行，块内容需缩进

示例如下：

::

  缩进后填写块内容

效果如下：

缩进后填写块内容

  1. 部分简化，前文带一个冒号，加一个空格后，双冒号接在前文后面，不另起行，同时会显示单个冒号，块内容同样缩进

示例如下：

这里是前面内容，下面引用: ::

  缩进后填写块内容

效果如下：

这里是前面内容，下面引用:

缩进后填写块内容

  1. 完全简化，双冒号接在前文后面，不另起行，同时会显示单个冒号，块内容同样缩进

示例如下：

这里是前面内容，下面引用::

> 在（部分/完全）简化形势下支持单行引用形式的嵌套
> 再来一个单行引用

效果如下：

这里是前面内容，下面引用:

> 在简化形势下支持单行引用形式的嵌套
> 再来一个单行引用

3.5.2. 行块 Line Blocks#

行块使用 | 指示符， 一般用于描述地址，歌词，诗歌，简单列表等。

**《忆江南》之二** --- 白居易


| 江南忆，最忆是杭州。
| 山寺月中寻桂子，郡亭枕上看潮头。
| 何日更重游？

效果如下：

《忆江南》之二 --- 白居易

江南忆，最忆是杭州。
山寺月中寻桂子，郡亭枕上看潮头。
何日更重游？

3.5.3. 块引用 Block Quotes#

块引用是 通过缩进来实现 的，引用块要在前面的段落基础上缩进。

通常引用结尾会加上出处(attribution)，出处的文字块开头是两个或者三个连续短横（"--","---"）后面加上出处信息。

块引用可以使用空的注释 .. 分隔上下的块引用。

注意在新的块和出处都要添加一个空行。

示例如下：

实际效果：

    “真的猛士，敢于直面惨淡的人生，敢于正视淋漓的鲜血。”

    --- 鲁迅

..

    “人生的意志和劳动将创造奇迹般的奇迹。”

    -- 涅克拉索

实际效果：

“真的猛士，敢于直面惨淡的人生，敢于正视淋漓的鲜血。”

—鲁迅

“人生的意志和劳动将创造奇迹般的奇迹。”

—涅克拉索

3.5.4. 文档测试块 Doctest Blocks#

文档测试块是交互式的Python会话，以 >>> 开始，一个空行结束，是一种特殊的文字块，内容不需要缩进 。

可直接复制到python的 docstrings中，用于为doctest模块提供测试环境。

当文字块语法和文档测试块语法同时出现时，文字块语法优先级更高。

>>> print('this is a Doctest block')
this is a Doctest block
目录