reStructuredText

概述

reStructuredText,重构建文本,是一种优秀的写作工具。

使用格式

基本原素

字符串元素

连续的字符组成字符串元素。

行元素

下划线(有时包括上划线)和文本构成的元素,例如标题、表格

块元素

具有相同缩进的元素为块元素,例如段落、表格。块元素以 空行 结束,不管多少空行,都视为一行。

页面元素

类似于行元素,但不多含缩进:

标题
============
分隔线
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
章节标题
=====================
_____________________
~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^
"""""""""""""""""""""

等等

注释

注释是以 .. 起始的超级块元素,注释中的内容只在源文件中显示,并不在结果中显示

.. 注释

  第二行
  第三行
  第二段
  第六行

新的开始

引导符 .. 前不能有其它字符,之后要有一个空格与注释内容分隔开( .. 同时是一个字串元素,前后都要有分隔符)

块引用

块引用是以 :: 起始的超级块元素,块引用的内容不作任何处理,以原文显示

块引用 ::

第一行
第二行

第四行

新的开始

引导符 :: 后必须有一个空行

基本格式

链接格式

网络链接

图片链接

源码

工程组织

Table Of Contents

Previous topic

结构化文本

Next topic

Sphinx

This Page