reStructuredText语法简单说明
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
另外一种形式:
`mikeGithub <https://github.com/mike-zhang>`_
图片
示例如下:
.. 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语法简单说明的更多相关文章
- Smali语法简单介绍
Smali语言其实就是Davlik的寄存器语言: Smali语言就是android的应用程序.apk通过apktool反编译出来的都有一个smali文件夹,里面都是以.smali结尾的文件,文件的展示 ...
- reStructuredText文件语法简单学习
reStructuredText 是一种扩展名为.rst的纯文本文件,通过特定的解释器,能够将文本中的内容输出为特定的格式 1. 章节标题 章节头部由下线(也可有上线)和包含标点的标题组合创建,其中下 ...
- Markdown和reStructuredText语法比较
reStructuredText在线编辑器 http://rst.ninjs.org/ ReST是Docutils的标记语法,Docutils是Python世界的文档工具集.也因为这样ReST在Pyt ...
- shell语法简单介绍
一.基本的语法 1.1.shell文件开头 shell文件必须以以下的行開始(必须方在文件的第一行): #!/bin/sh 符号#!用来告诉系统它后面的參数是用来运行该文件的程序.在这个样例中我们 ...
- Markdown语法简单介绍
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式. 一.标题 # 这是标题一 ## 这是标题二 ### 这是标题三 #### 这是标题 ...
- reStructuredText语法
reStructuredText 除了makedown语法这还存在另一种语法reStructuredText 相对Markdown来说,在写书方面更有优势: 使用sphnix能够自动生成目录和索引文件 ...
- php5.3之前版本升级至5.3以及更高版本后部分语法简单归纳
1. Deprecated: Assigning the return value of new by reference is deprecated in /usr/local/www/uugui/ ...
- Python 基础语法+简单地爬取百度贴吧内容
Python笔记 1.Python3和Pycharm2018的安装 2.Python3基础语法 2.1.1.数据类型 2.1.1.1.数据类型:数字(整数和浮点数) 整数:int类型 浮点数:floa ...
- markdown语法简单总结
最常用的十个MarkDown语法总结: 标题:只要在这段文字前加 # 号即可 # 一级标题 最大 ## 二级标题 ### 三级标题 无序列表:在文字前加上 - 或 * 有序列表:在文字前加1. 2. ...
随机推荐
- python中@staticmethod、@classmethod和实例方法
1.形式上的异同点: 在形式上,Python中:实例方法必须有self,类方法用@classmethod装饰必须有cls,静态方法用@staticmethod装饰不必加cls或self,如下代码所示: ...
- Noj - 在线强化训练2
状态 题号 竞赛题号 标题 1572 A 九鼎之尊(一) 1573 B 九鼎之尊(二) 1453 C 筛法(Sieve Method) 1134 D 亲密数(close numbers ...
- 20165319 2017-2018-2《Java程序设计》课程总结
一.每周作业链接汇总 预备作业一:我期望的师生关系 20165319 我所期望的师生关系 预备作业二:学习基础和C语言基础调查 20165319 学习基础和C语言基础调查 摘要: 技能学习经验 c语言 ...
- POJ 3126 Prime Path【BFS】
<题目链接> 题目大意: 给你两个四位数,它们均为素数,以第一个四位数作为起点,每次能够变换该四位数的任意一位,变换后的四位数也必须是素数,问你是否能够通过变换使得第一个四位数变成第二个四 ...
- mySql的UDF是什么
CRUD:添删改查 UDF是mysql的一个拓展接口,UDF(Userdefined function)可翻译为用户自定义函数,这个是用来拓展Mysql的技术手段. 1 MySQL简介 MySQL是最 ...
- linux 学习笔记 APACHE安装总结
#cd /usr/local #mkdir APACHE #tar zxvf /usr/etc/DEV/httpd-2.2.9.tar.gz #mv httpd-2.2.9/* . #rm -rf h ...
- 解决VS打开文件出现No EditorOptionDefinition export found for the given option name问题
转载自http://stackoverflow.com/questions/23893497/no-editoroptiondefinition-export-found-error的第一个回答 Af ...
- [OC] 使用 cocoaPods 导入 AFNetworking
AFNetworking的GitHub地址: https://github.com/AFNetworking/AFNetworking 假设我们建立了一个叫做AFNWlearning的工程. 1.打开 ...
- IntelliJ IDEA使用教程(简介)
最智能的IDE IDEA 全称IntelliJ IDEA 是java语言开发的集成环境,IntelliJ在业界被公认为最好的java开发工具之一,尤其在智能代码助手.代码自动提示.重构.J2EE支 ...
- Android强制关闭某个指定应用 “关闭应用”
强制关闭指定的应用程序: // 传入应用的包名即可kill掉应用 private void forceStopApp(String packageName) { ActivityManager am ...