辅助侧边栏和目录#

辅助侧边栏包含有关当前页面的信息。它从页面顶部(在标题中)开始,并向下延伸(默认情况下,从页面的右侧开始)。本页介绍控制和自定义辅助侧边栏的方法。

重命名页面内的目录#

您可以重命名右侧边栏中页面内目录的标题:

html_theme_options = {
    "toc_title": "{your-title}"
}

标题的默认值为 Contents

默认显示更多级别的页面内目录#

通常,页面内目录中仅显示页面的二级标题,更深层次的标题仅在它们属于活动部分时(即滚动到屏幕上时)显示。

您可以通过使用以下配置来默认显示更深层次的目录,指示应显示多少级别:

html_theme_options = {
  "show_toc_level": 2
}

现在,无论页面上显示什么内容,指定级别及以下的所有标题都将显示。