如果你正在编写 GitBook 文档并想给读者提供目录导航，那么可以使用 gitbook-plugin-page-toc 插件。本文将详细介绍该插件的安装和使用方法。
安装
首先，在你的 GitBook 项目下执行以下命令：
npm install gitbook-plugin-page-toc
使用方法
安装插件后，在项目的 book.json 文件的 plugins 字段中添加以下配置：
{
"plugins": ["page-toc"]
}添加完毕后，重新编译 GitBook 即可看到页面目录。
高级用法
默认情况下，gitbook-plugin-page-toc 插件会在每个页面的顶部展示该页面的目录导航，但你可以通过以下配置来决定目录导航的具体位置：
{
"pluginsConfig": {
"page-toc": {
"position": "before"
}
}
}position 的可选值为 "before" 和 "after"，分别表示目录导航应该在正文之前或之后展示。
此外，你还可以通过以下方式来决定目录导航应该包含哪些页面：
{
"pluginsConfig": {
"page-toc": {
"includeLevel": [1, 2]
}
}
}includeLevel 表示包含哪些目录级别。默认为 [2, 3]，即只包括二级和三级目录。在实际使用中，你可以根据需要控制目录的深度和详细程度。
示例代码
以下是一篇包含二级和三级目录的样例页面：
-- -------------------- ---- ------- - --- ------- -- ---- - -- - ---- --- ---- - ------------ --- ---- - ----------------- -- ---- - -- - ----- --- ---- - -- - -----
在 GitBook 中编译该页后，你将看到一个带有二级和三级目录的页面目录。目录的深度和条目（标题）的数量决定了如何呈现该目录。
总结
gitbook-plugin-page-toc 是一款 GitBook 插件，可以为您在文档中提供目录导航，让读者更好地了解页面结构和内容。本文介绍了如何安装和使用这个插件，以及如何进行配置，让你更加自由地控制你文档的展示方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671d730d0927023822cbb