文档编辑

文档编辑的核心在于 文本编辑器 和 reStructuredText语法

text编辑器

支持 reStructuredText语法 的文本编辑器有

rst基本语法

标题

  • 一级标题：========
  • 二级标题：--------
  • 三级标题：~~~~~~~~
  • 四级标题：^^^^^^^^
  • 五级标题：++++++++
  • 六级标题：````````

段落

  • 空行分段
代码示例 输出示例
../../_images/13.png
../../_images/21.png
  • 回车自动续行
代码示例 输出示例
../../_images/31.png
../../_images/41.png
  • 不留白续行
代码示例 输出示例
../../_images/51.png
../../_images/61.png
  • 插入换行
代码示例 输出示例
../../_images/71.png
../../_images/81.png
../../_images/91.png
../../_images/101.png
  • 段落缩进
代码示例 输出示例
../../_images/112.png
../../_images/121.png
../../_images/131.png
../../_images/14.png

代码块

代码示例 输出示例
../../_images/15.png
../../_images/16.png

列表

  • 无序列表
代码示例 输出示例
../../_images/17.png
../../_images/18.png
  • 有序列表
代码示例 输出示例
../../_images/19.png
../../_images/20.png
  • 列表续行、段落和代码块
代码示例 输出示例
../../_images/211.png
../../_images/22.png

定义

代码示例 输出示例
../../_images/23.png
../../_images/24.png

字体

  • 粗体和斜体
代码示例 输出示例
../../_images/25.png
../../_images/26.png
  • 删除线
代码示例 输出示例
../../_images/27.png
../../_images/28.png
  • 下划线
代码示例 输出示例
../../_images/29.png
../../_images/30.png
  • 上标、下标
代码示例 输出示例
../../_images/311.png
../../_images/32.png
  • 等宽字体
代码示例 输出示例
../../_images/33.png
../../_images/34.png
  • 引言
代码示例 输出示例
../../_images/35.png
../../_images/36.png
  • 清除标记空白
代码示例 输出示例
../../_images/37.png
../../_images/38.png

链接

  • URL自动链接
代码示例 输出示例
../../_images/39.png
../../_images/40.png
  • 文字链接
代码示例 输出示例
../../_images/411.png
../../_images/42.png
  • 内部跳转
代码示例 输出示例
../../_images/43.png
../../_images/44.png
  • 脚注
代码示例 输出示例
../../_images/45.png
../../_images/46.png

图片

代码示例 输出示例
../../_images/47.png
../../_images/48.png

表格

代码示例 输出示例
../../_images/49.png
../../_images/50.png

其它

  • 转义
代码示例 输出示例
../../_images/511.png
../../_images/52.png

注意

  • 各种标记字符与其它文本内容之间最好留一个空格，否则会报语法警告