ReStructuredText 速查表

本文根据 Devhints / ReStructuredText 翻译。代码示例及版本范围沿用原文。

关于

ReStructuredText 是一种用于编写文档的标记语言。

• https://en.wikipedia.org/wiki/ReStructuredText

注释

.. @theme 2010
.. include:: ../themes/2010/common.rst
.. contents::
.. |substitute| replace:: replacement name

标题

Heading
=======

.. class:: brief

Hello there. |substitute| **This is bold**


 - Bullet list with a link_ (or `link with words`_)
 - Yes

.. _link: http://link.org

PDF 分页符

.. raw:: pdf

   PageBreak oneColumn

链接目标 (Link targets)

Internal link target_.

.. _target:

This is where _target will end up in.

表格 (?)

.. class:: hash-table

.. list-table::

   * - :key:`Cuisine:`
     - :val:`French/fusion`
   * - :key:`Number of ingredients:`
     - :val:`8`
   * - :key:`Preparation time:`
     - :val:`30 hours`