reStructuredText 文件

reStructuredText 文件#

除了在 Markdown 中编写内容外，Jupyter Book 还支持使用 reStructuredText 编写内容，这是 Python 文档社区中常见的另一种标记语言。

Warning

使用 reStructuredText 编写内容仅推荐给已经熟悉它的用户。对于其他人，我们推荐使用 MyST Markdown，它具有 rST 和 Sphinx 的所有相同功能，但采用了 Markdown 风格。

由于 Jupyter Book 在底层使用了 Sphinx，任何为 Sphinx 生态系统编写的 rST 文档也应该可以在 Jupyter Book 中使用。如果你已经有大量的 rST 文档，并希望尝试在 Jupyter Book 中使用它们，这将特别有用。

有关使用 reStructuredText 编写内容的更多信息，我们推荐阅读 Sphinx rST 文档。

要在 Markdown 中插入 rST，可以使用 eval-rst 指令：

```{eval-rst}
.. note::

   用 reStructuredText 编写的注释。

.. include:: ./include-rst.rst
```

Note

用 reStructuredText 编写的注释。