mkdocs - 如何为单个文档指定 toc_depth？

Question

我想更改 TOC 上 table of contents 的标题数量的深度。

我可以看到 toc_depth 选项作为配置选项存在，但这是全局的。有没有办法指定单个文档？

干杯

Answer 1

您可以使用自定义模板更新您的模板。 覆盖toc.html模板文件项宏https://github.com/mkdocs/mkdocs/blob/234fb10e543af4c5dcf0ee54c1d831846303f4cb/mkdocs/themes/mkdocs/toc.html#L9并替换：

{%- if item.level <= config.theme.navigation_depth %}

通过类似的方式：

{% if not page.meta.toc_depth or item.level <= page.meta.toc_depth or item.level <= config.theme.navigation_depth %}

并在 .md 页面的元标题中添加 toc_depth。

---
description: this is the page I want TOC to only display level 2 max.
toc_depth: 2
---

如果您使用Material for MkDocs theme，您可以使用以下内容覆盖partials/toc-item.html 文件：

{% if not page.meta.toc_depth or toc_item.level <= page.meta.toc_depth %}