目录#

目录让您可以轻松查看和导航文档结构。

当您打开笔记本、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.

对于包含可运行代码单元格的笔记本章节的目录标题,会添加上下文菜单,单击“选择并运行此标题的单元格”选项将使这些单元格在笔记本中运行。这是一个显示其用法的动画。

../_images/runcell.gif

如果设置中将 syncCollapseState 属性设置为 true,则单元格标题的折叠状态将在目录和笔记本之间同步。如果目录中的标题被折叠,笔记本也会折叠,同样,在笔记本中展开单元格也会展开目录。要激活该功能,请转到设置并单击“设置编辑器”,然后转到“目录”部分,并在“用户首选项”中勾选 syncCollapseState 复选框。这是一个显示其用法的动画。

../_images/syncCollapseState.gif

单元格输出中的标题默认在目录和笔记本中编号。这可以通过将设置 includeOutput 更改为 false 来调整。要执行此操作,请转到设置并单击“设置编辑器”,然后转到“目录”部分,并在“用户首选项”中添加未勾选的 includeOutput 复选框。这是一个显示其用法的动画。

../_images/includeOutput.gif

设置#

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

  • includeOutput:是否列出单元格输出中的标题。

  • maximalDepth:最大标题深度(默认值:4)。

  • numberingH1:是否对一级标题 (h1) 编号。

  • numberHeaders:是否对标题编号。

  • syncCollapseState:是否同步单元格和目录的折叠状态。

  • baseNumbering:标题编号的起始点(默认值:1)。

注意

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