目录#

目录使您能够轻松查看和浏览文档的结构。

当您打开笔记本、Markdown、Latex 或 Python 文件时，目录会自动生成在左侧边栏中。条目是可点击的，并且会滚动文档到相应的标题。

在侧边栏面板中，您可以对标题进行编号、折叠章节以及在文件中进行导航。

以下动画展示了目录在笔记本中的使用情况

A GIF displaying how to use the table of contents feature within a notebook. It toggles which cells types are listed and toggles expanding and collapsing headings.

目录将通过获取 Markdown 单元格中的所有标题来自动生成您的笔记本。每个列出的章节都将链接到文档中的实际章节。

注意

包含类 jp-toc-ignore 的 HTML 标签的 Markdown 标题将被忽略；例如 # Title <a class="jp-toc-ignore"></a>。

自动章节编号将遍历您的笔记本，并根据您的标题对章节和子章节进行编号。这意味着，如果您多次移动了一个或多个大章节，您无需自己遍历文档并重新对其进行编号，以及重新编号其所有子章节。

可以跳过一级标题 (h1) 的自动章节编号。您可以通过目录工具栏中的“更多操作”按钮切换该选项。以下动画展示了其使用情况

A GIF showing how to toggle Automatic section numbering for headings within a notebook. Clicking the button instantly applies multilevel numbering to each heading.

上下文菜单将添加到那些包含可运行代码单元格的笔记本章节的目录标题中，单击“选择并运行此标题的单元格”选项将使单元格在笔记本中运行。以下动画展示了其使用情况

如果在设置中将 syncCollapseState 属性设置为 true，则单元格标题的折叠状态将在目录和笔记本之间同步。如果目录中的标题被折叠，则笔记本也将被折叠，类似地，展开笔记本中的单元格将展开目录。要激活该功能，请转到设置，单击“设置编辑器”，然后转到“目录”部分，在“用户偏好设置”中选中 syncCollapseState 框。以下动画展示了其使用情况

默认情况下，单元格输出中的标题将在目录和笔记本中进行编号。可以通过将设置 includeOutput 更改为 false 来调整此设置。要执行此操作，请转到设置，单击“设置编辑器”，然后转到“目录”部分，在“用户偏好设置”中取消选中 includeOutput 框。以下动画展示了其使用情况

设置#

可以通过设置修改目录的行为，这些设置可以在 JupyterLab 的设置编辑器中进行设置。

includeOutput : 是否列出单元格输出中的标题。
maximalDepth : 最大标题深度（默认值：4）。
numberingH1 : 是否对一级标题（h1）进行编号。
numberHeaders : 是否对标题进行编号。
syncCollapseState : 是否同步单元格和目录的折叠状态。
baseNumbering : 标题编号的起始点（默认值：1）。

注意

设置效果取决于文档类型。