reStructuredText 备忘单¶
地震“学”所有教程文档均采用 reStructuredText （reST）标记语言编写。我们总结了编写地震“学”文档时所使用的一些 reST 常用语法，更完整的 reST 语法说明请参考 Sphinx 官方文档。如果要预览 reST 编写的文档，可尝试 reST 在线编辑器，如 http://rst.ninjs.org/。
下面的内容中，右侧为原始 reST 标记语言写的文件源码，左侧为渲染后实际网页中显示的效果。
标题¶
在标题下加标点符号便可以创建标题，标点符号至少要和标题一样长，如上标题。
格式化文字¶
在书写文字时可以使用 粗体 标记、
斜体 标记，以及行内代码（如 wc /etc/passwd）
链接¶
内部链接¶
链接当前目录下的某文档： 维护指南
用绝对路径链接任一文档，source 目录是根目录：
维护指南
链接当前文档内的某标题： 格式化文字
默认使用该文档的标题作为链接的文字，也可以自行指定链接文字： 指向《维护指南》的链接
列表¶
无序列表：
地震“学”软件
地震“学”科研入门教程
地震“学”参考书
有序列表：
地震“学”软件
地震“学”科研入门教程
地震“学”参考书
术语定义列表：
- 地震“学”
地震“学”是一群地震学的搬砖工成立的团队。
核心目标是提供地震学科研入门培训材料、整理和维护地震学学习资料、促进地震学中文社区的交流和发展。
- 地震“学”科研入门教程
地震“学”小组撰写的《地震“学”科研入门教程》主要目的是帮助地震学新手快速入门，以尽快开展实际的科研工作。
代码¶
使用 echo 命令输入字符：
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
使用 echo 命令输入字符:
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
使用 echo 命令输入字符：
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
表格¶
版本号 |
代号 |
发布日期 |
|---|---|---|
macOS 10.13 |
High Sierra |
2017 年 9 月 |
macOS 10.14 |
Mojave |
2018 年 9 月 |
macOS 10.15 |
Catalina |
2019 年 10 月 |
macOS 11 |
Big Sur |
2020 年 9 月 |
指令¶
注解
note 指令用于插入一个注解。
警告
warning 指令用于插入一个警告信息。
重要
important 指定用于插入重要信息。
小技巧
tip 指令用于插入“小技巧”。
除了以上提到的指令外，还有 attention、caution、
danger、error 和 hint。其用法相同。
自定义信息
admonition 可以用于插入自定义信息。
段落
----
段落是由一个或多个空白行分隔的文本块。
同一段落的所有行都必须
左对齐到相同的缩进级别。
标题
----
在标题下加标点符号便可以创建标题，
标点符号至少要和标题一样长，如上标题。
子标题
^^^^^^
子标题下的段落。
子子标题
""""""""
有些编辑器显示的标题和标点符号长度可能不准确，
不确定的时候可以使用 vim 编辑器检查。
标题级别与使用的标点符号无关，
建议编写文档时使用统一的标点符号来确定标题级别。
格式化文字
----------
在书写文字时可以使用 **粗体** 标记、
*斜体* 标记，以及行内代码（如 ``wc /etc/passwd``）
链接
-----
外部链接
^^^^^^^^
邮箱：seismo-learn@163.com
网址链接：https://seismo-learn.org/seismology101
带超链接的文字：`地震“学”主站 <https://seismo-learn.org/>`__
内部链接
^^^^^^^^
链接当前目录下的某文档： :doc:`general-guidelines`
用绝对路径链接任一文档，:file:`source` 目录是根目录：
:doc:`/general-guidelines`
链接当前文档内的某标题： `格式化文字`_
默认使用该文档的标题作为链接的文字，也可以自行指定链接文字：
:doc:`指向《维护指南》的链接 <general-guidelines>`
列表
-----
无序列表：
- 地震“学”软件
- 地震“学”科研
入门教程
- 地震“学”参考书
有序列表：
1. 地震“学”软件
2. 地震“学”科研入门教程
3. 地震“学”
参考书
术语定义列表：
地震“学”
地震“学”是一群地震学的搬砖工成立的团队。
核心目标是提供地震学科研入门培训材料、
整理和维护地震学学习资料、
促进地震学中文社区的交流和发展。
地震“学”科研入门教程
地震“学”小组撰写的《地震“学”科研入门教程》
主要目的是帮助地震学新手快速入门，
以尽快开展实际的科研工作。
代码
-----
使用 echo 命令输入字符：
::
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
使用 echo 命令输入字符::
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
使用 echo 命令输入字符：
.. code-block:: bash
# 使用 echo（回声）命令输出 Hello World!
$ echo "Hello World"
表格
-----
.. table:: 近几年的 macOS 系统版本号
:align: center
============= ============= ==============
版本号 代号 发布日期
============= ============= ==============
macOS 10.13 High Sierra 2017 年 9 月
macOS 10.14 Mojave 2018 年 9 月
macOS 10.15 Catalina 2019 年 10 月
macOS 11 Big Sur 2020 年 9 月
============= ============= ==============
图片
----
利用 ``figure`` 指令插入图片：
.. figure:: logo.png
:alt: 地震“学” logo
:width: 25.0%
:align: center
地震“学” logo
图片若不在同一目录下，可以使用绝对路径。
根目录是 :file:`source` 目录，如 :file:`/logo.png`。
数学公式
---------
可以使用 LaTeX 语法输入公式。
行内公式：勾股定理 :math:`a^2+b^2=c^2`
行间公式：
.. math::
\gamma = \sqrt{(\alpha^2 + \beta^2)}
语义标记
--------
按键： :kbd:`Enter` :kbd:`Shift`
图片下载：:download:`logo.png`
文件下载：:download:`general-guidelines.rst`
文件：:file:`general-guidelines.rst`
指令
-----
.. note::
``note`` 指令用于插入一个注解。
.. warning::
``warning`` 指令用于插入一个警告信息。
.. important::
``important`` 指定用于插入重要信息。
.. tip::
``tip`` 指令用于插入“小技巧”。
除了以上提到的指令外，还有 ``attention``、``caution``、
``danger``、``error`` 和 ``hint``。其用法相同。
.. admonition:: 自定义信息
``admonition`` 可以用于插入自定义信息。