3. 基本语法¶

3.1 标题等级¶

3.  基本语法
=================

二级标题¶

二级标题
--------

三级标题¶

三级标题
****

四级标题¶

四级标题
^^^^^^^^

3.2 行内标记¶

斜体: 文本或文本得强调 (斜体对中文一般效果不好)
粗体: 文本或文本得加重 (加黑)
引用: 文本 或 文本 得代码引用
下标: H₂O
上标: E = mc²

* 斜体:  *文本* 或 :emphasis:`文本` 得 强调 (斜体 对中文一般效果不好)
* 粗体:  **文本** 或 :strong:`文本` 得 加重 (加黑)
* 引用:  ``文本`` 或 :literal:`文本` 得 代码引用
* 下标:  H\ :sub:`2`\ O
* 上标:  E = mc\ :sup:`2`

3.3 列表¶

列表1
列表2
- 嵌套的列表1
- 嵌套的列表2
列表3
列表4

* 列表1
* 列表2
    * 嵌套的列表1
    * 嵌套的列表2
* 列表3
* 列表4

列表1
列表2
1. 嵌套的列表1
2. 嵌套的列表2
列表3
列表4

#. 列表1
#. 列表2
    #. 嵌套的列表1
    #. 嵌套的列表2
#. 列表3
#. 列表4

3.4 源代码¶

源代码示例这里是简单的源代码示例, 后面专门讲更复杂的

这是源代码

::

   这是源代码

查看代码高亮

3.5 表格¶

Header1	Header2	Header3	header4
body row 1, column 1	column 2	column 3	column 4
body row 2	...	...

+------------------------+------------+----------+----------+
|Header1                 | Header2    | Header3  | header4  |
|                        |            |          |          |
+========================+============+==========+==========+
| body row 1, column 1   | column 2   | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2             | ...        | ...      |          |
+------------------------+------------+----------+----------+

例如用于接口参数表格

参数	类型	可空	默认值	注释
name	string	N		用户姓名
age	number	Y	18
mobile	string	N		手机号码
birthday	date	Y		生日
				第一列也可以为空

==============      =======   ========      ===========     =======
参数                类型      可空          默认值          注释
==============      =======   ========      ===========     =======
name                string    N                             用户姓名
age                 number    Y             18
mobile              string    N                             手机号码
birthday            date      Y                             生日
\                                                           第一列也可以为空
==============      =======   ========      ===========     =======

3.6 图片¶

.. image:: _static/flower.jpg

自定义图片大小和对齐方式

.. image:: _static/flower.jpg
    :height: 200
    :width: 100
    :align: center

3.7 超链接¶

这是一个指向百度的链接.

查看 label_list

查看 2. 安装

3.8 脚注¶

水的沸点是100℃ [1].

注释

[1]	气压为一个标准大气压时

3.9 引证¶

本文中示例来自 [Google] 和 [百度]

3.10 特殊标记¶

Tip

这是一个提示框

.. tip:: 这是一个提示框

Note

这是一个提示框

.. note:: 这是一个提示框

Warning

这是一个提示框

.. warning:: 这是一个提示框

Error

这是一个提示框

.. error:: 这是一个提示框

还有attention, caution, danger, hint, important, admonition 等其他标记

3.11 注释¶

.. 这是注释

[Google]

最强大的搜索引擎.

[百度]

最大的卖假药的网站