mdbook-pagetoc

为每个页面提供目录表的 mdbook 插件。使用来自 mdBook-pagetoc 的 css/js。

显示示例

来自 mdBook-pagetoc 的示例图片

说明

• 仅支持 html 渲染器。

• 在首次运行 mdbook build 时，它会创建两个文件 pagetoc.css 和 pagetoc.js。

• 首次运行后，您可以自定义其中任何一个。

配置

• 添加到 book.toml 配置

  [preprocessor.pagetoc]
  [output.html]
  additional-css = ["theme/pagetoc.css"]
  additional-js  = ["theme/pagetoc.js"]
  

• 占位符 <div class="sidetoc"><nav class="pagetoc"></nav></div> 将被插入到 <main> 标签内部。即，这会替换

  <main>
     {{{ content }}}
  </main>
  

  为

  <main><div class="sidetoc"><nav class="pagetoc"></nav></div>
      {{{ content }}}
  </main>
  

• 如果不进行自定义，您可能希望将条目添加到 .gitignore 中以保持您的仓库干净

  theme/pagetoc.css
  theme/pagetoc.js
  

• 自定义：要自动隐藏只有一个标题时，将此片段添加到 pagetoc.css

  a[class^='pagetoc-H']:only-child {
    display: none;
  }
  

致谢

• mdBook-pagetoc

替代方案

• mdbook-theme