reStructuredText 是扩展名为.rst的纯文本文件,含义为"重新构建的文本"",也被简称为:RST或reST。

官方网址:

http://docutils.sourceforge.net/rst.html

rst用户手册:

http://docutils.sourceforge.net/rst.html#user-documentation

http://docutils.sourceforge.net/docs/user/rst/quickref.html

rst 文件是轻量级标记语言的一种,被设计为容易阅读和编写的纯文本,并且可以借助Docutils这样的程序进行文档处理,也可以转换为HTML或PDF等多种格式, 或由Sphinx-Doc这样的程序转换为LaTex、man等更多格式。

这里记录下常见的语法,更多内容请参考官方手册。

标题

可以表示标题的符号有:

= - ` : ' " ~ ^ _  * + # < >

示例如下:

标题
================================================= 一级标题
------------------------------------------------- 二级标题
`````````````````````````````````````````````````

效果如下:

段落

段落是被空行分割的文字片段,左侧必须对齐(没有空格,或者有相同多的空格)。

列表

可以表示列表的符号有:

-、*、+

不同的符号结尾需要加上空行,下级列表需要有空格缩进。

示例如下:

- 列表1

    - 子列表1

    * 子列表2

    + 子列表3

* 列表2

+ 列表3

效果如下:

  • 列表1

    • 子列表1
    • 子列表2
    • 子列表3
  • 列表2
  • 列表3

代码块(文字块)

在需要插入文本块的段落后面加上 :: ,接着一个空行,然后就是文字块了。 文字块开头要有缩进,结束标志是新的一段文本贴开头(即没有缩进)。

示例如下:

::

    import os
os.system("ls")

效果如下:

import os
os.system("ls")

超链接

reStructuredText会自动将网址生成超链接。

比如:

https://github.com/mike-zhang

https://github.com/mike-zhang

另外一种形式:

`mikeGithub <https://github.com/mike-zhang>`_

mikeGithub

图片

示例如下:

.. image:: images/.png

粗体和斜体

这是 **粗体** ,这是 *斜体*
不留白的\ **粗体**\ 和\ *斜体*\

这是 粗体 ,这是 斜体

不留白的粗体斜体

上标和下标

- Water: H\ :sub:``\ O
- E = mc\ :sup:``

rst简单示例

rst简单示例如下:

文章标题
=================================================== 操作系统 : CentOS7..1611_x64 gcc版本 :4.8. go 版本 : go1.8.3 linux/amd64 Python 版本 : 2.7. 一级标题
--------------------------------------
二级标题
````````````````````````````````````````````````` - 列表1 - 列表2 代码块
:: import os
os.system("ls") 图片: .. image:: images/20120604.1..png 超链接: https://github.com/mike-zhang `mikeGithub <https://github.com/mike-zhang>`_

本文github地址:

https://github.com/mike-zhang/mikeBlogEssays/blob/master/2018/20180905_reStructuredText语法简单说明.rst

欢迎补充

reStructuredText语法简单说明的更多相关文章

  1. Smali语法简单介绍

    Smali语言其实就是Davlik的寄存器语言: Smali语言就是android的应用程序.apk通过apktool反编译出来的都有一个smali文件夹,里面都是以.smali结尾的文件,文件的展示 ...

  2. reStructuredText文件语法简单学习

    reStructuredText 是一种扩展名为.rst的纯文本文件,通过特定的解释器,能够将文本中的内容输出为特定的格式 1. 章节标题 章节头部由下线(也可有上线)和包含标点的标题组合创建,其中下 ...

  3. Markdown和reStructuredText语法比较

    reStructuredText在线编辑器 http://rst.ninjs.org/ ReST是Docutils的标记语法,Docutils是Python世界的文档工具集.也因为这样ReST在Pyt ...

  4. shell语法简单介绍

    一.基本的语法 1.1.shell文件开头 shell文件必须以以下的行開始(必须方在文件的第一行):  #!/bin/sh  符号#!用来告诉系统它后面的參数是用来运行该文件的程序.在这个样例中我们 ...

  5. Markdown语法简单介绍

    Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式. 一.标题 # 这是标题一 ## 这是标题二 ### 这是标题三 #### 这是标题 ...

  6. reStructuredText语法

    reStructuredText 除了makedown语法这还存在另一种语法reStructuredText 相对Markdown来说,在写书方面更有优势: 使用sphnix能够自动生成目录和索引文件 ...

  7. php5.3之前版本升级至5.3以及更高版本后部分语法简单归纳

    1. Deprecated: Assigning the return value of new by reference is deprecated in /usr/local/www/uugui/ ...

  8. Python 基础语法+简单地爬取百度贴吧内容

    Python笔记 1.Python3和Pycharm2018的安装 2.Python3基础语法 2.1.1.数据类型 2.1.1.1.数据类型:数字(整数和浮点数) 整数:int类型 浮点数:floa ...

  9. markdown语法简单总结

    最常用的十个MarkDown语法总结: 标题:只要在这段文字前加 # 号即可 # 一级标题 最大 ## 二级标题 ### 三级标题 无序列表:在文字前加上 - 或 * 有序列表:在文字前加1. 2.  ...

随机推荐

  1. Effective前端1---chapter 1 HTML/CSS优化

    最近在读高效前端:web高效编程与优化实践,借此本书的感受总结下前端代码与性能优化,纯属自己见解,如有错误,欢迎指出. 1.能用HTML/CSS解决的问题就不要用js 场景1:鼠标悬浮时显示 鼠标悬浮 ...

  2. 微信小程序开发指南

    https://developers.weixin.qq.com/miniprogram/introduction/#%E4%BA%A7%E5%93%81%E5%AE%9A%E4%BD%8D%E5%8 ...

  3. html 知识点

    web服务本质 import socket def main(): sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.bind ...

  4. C# 网络编程之基于SMTP发送电子邮件

     本文主要讲述基于C#网络编程的发送邮件的编程,邮件发送功能是基于邮件协议的,常见的电子邮件协议有SMTP(简单邮件传输协议).POP3(邮局协议).IMAP(Internet邮件访问协议),文章主要 ...

  5. php 单例模式和工厂模式

    单例模式又称为职责模式,它用来在程序中创建一个单一功能的访问点,通俗地说就是实例化出来的对象是唯一的.所有的单例模式至少拥有以下三种公共元素:1. 它们必须拥有一个构造函数,并且必须被标记为priva ...

  6. 南方IT学校期末PCB结课项目考试(实操)说明书

    南方IT学校期末结课项目考试(实操)说明书(一) 课程:<印制电路板设计技术>(二) 项目:笔记本电脑电源适配器的印制电路板设计(三) 背景说明:如今笔记本已经进入千家万户,作为给电脑充电 ...

  7. docker自动重启容器

    docker run --restart=always  -d --name myunbuntu ubuntu /bin/bash -c "l am a docker"   //无 ...

  8. IDEA+Maven:cannot download sources

    把IDEA的maven换成maven2

  9. redis(五)

    发布订阅 发布者不是计划发送消息给特定的接收者(订阅者),而是发布的消息分到不同的频道,不需要知道什么样的订阅者订阅 订阅者对一个或多个频道感兴趣,只需接收感兴趣的消息,不需要知道什么样的发布者发布的 ...

  10. Mybatis Hibernate->MyBatis

    Hibernate对JDBC的封装程度比较高,不需要编写SQL(Structured Query Language)语句,只要使用HQL(Hibernate Query Language)语言就可以了 ...