help.md

Markdown

• ===和---为一级标题和二级标题
• 1-6个#来表示主题的级别，#为一级，##为二级
• >表示引用段
• ` 是内嵌代码，三个连续是代码段，后面可以跟语言声明
• + - *是列表符，后边跟空格，1.是有序列表
• * _三个连续是分割线, -也可以，又是需要加空格防止作为主题解析
• |是表格列分割符，表头下一行跟|---|是行分割，其中加:用来标识对齐，左边是左对齐，右边是右对齐，两边都加是居中
• * _ 是字体标识，一个是_斜体_，两个是粗体
• [mark](url)是链接
• ![mark](url)是图片
• [mark][id]是参考,参考在后边有[id]: url来说明
• <url>会自动转换为链接
• \用来转义
• 增加空格可以防止连续解析

[note] [id]
[id]: http://www.google.com

---

reStructedText

reStructedText是Python的标准文档格式。

段落

相同缩进的文本是一个层次的段落

使用空行分割段落 |表示本行不续行

标题

可以使用除文本外的其他字符标识，不少于文字的长度 如： # * = - ^ ~ : . _ + ” `等

文本

• 使用缩进表示层次
• *标识文本状态，1个表示斜体，两个表示粗体
• 两个`表示引用
• \表示不转义

表格

+----+-----+
| wo | ni |
+====+=====+
| 1 | 2 |
+----+-----+

注释

以..开始，其后空格与内容隔离
.. _链接:http://www.baidu.com
.. [脚注] 内容

引用

::表示引用
其后必须空一行
>>> 表示提示符引用

代码

::表示代码
.. code-block:: python来声明语言

图片

|img|
.. |img| image:: http://

元素

以_结尾，或以|包裹
需要在注释中解析
链接_
[脚注]_
|引用|
+ - *表示无序列表
1. a.表示有序列表
#.表示自动列表

定义

用：包裹
后边跟说明

对象

:命令: `内容`
自定义： :命令: `内容`，在注释中.. 命令:: 字符串