github - 在 reStructuredText 中将 TOC 标题显示为标题(或将其完全隐藏)

Question

我需要一个我正在编辑的 reStructuredText (.rst) 文档的目录，所以我添加了

.. contents:: Table of Contents

在适当的地方，它工作正常。

问题是，至少在 GitHub 的 RST 解析器/渲染器/无论如何，“目录”标题显示就像正常的非标题文本一样，当我想要一个 2 级标题时。

Here's the README.rst file我正在努力改变。请注意“目录”看起来不像节标题或标题。

有没有办法

将 TOC 标题设置为 2 级标题，或

完全禁用 TOC 标题，所以我可以添加我自己的？ (类似于以下内容)

Table of Contents
-----------------
.. contents:: :disable_title: true

Answer 1

您可以通过组合 :local: option 来禁用 TOC 标题。省略目录标题:

Your h2 level title here
------------------------
.. contents::
   :local:

但要注意本地选项 将 TOC 本地化为仅列出放置它的部分的子部分 而不是列出文档中的每个部分。如果您仍想包含所有内容，请制作一个顶级标题并将 TOC 直接放在其下方。但是，这仍将排除顶级标题本身。