前言
在开发自己的 GitBook 的时候，通常会需要一个目录，以便于读者快速了解书籍的大纲和章节结构。而 GitBook 内置的目录插件不够灵活，不能完全满足需求，因此我们需要一个可以自动生成目录的插件。那么，本文介绍的 npm 包 gitbook-plugin-summary-generator，就是一个很不错的选择。
本文将会对 gitbook-plugin-summary-generator 的使用进行详细介绍，并提供一些示例代码，帮助大家更好地理解和应用它。
安装
使用 gitbook-plugin-summary-generator 前，我们需要先安装 GitBook。如果您已经安装了 GitBook，那么可以直接在书籍目录下运行以下命令安装 gitbook-plugin-summary-generator：
$ npm install gitbook-plugin-summary-generator
配置
在 GitBook 中，有两种方式来配置插件：一种是在 book.json 文件中配置，另一种是在 README.md 或 SUMMARY.md 文件中使用标记来配置。
我们选择第一种方式，打开 book.json 文件，在 plugins 中添加 gitbook-plugin-summary-generator：
{
"plugins": ["gitbook-plugin-summary-generator"]
}同时，可以在该配置中设置一些参数。例如，我们可以设置是否显示子标题：
{
"plugins": ["gitbook-plugin-summary-generator"],
"pluginsConfig": {
"summary-generator": {
"hideSubtitle": false
}
}
}常用参数有以下几个：
hideSubtitle：是否显示子标题，默认为false。depth：目录显示的最大深度，默认为3。class：目录的 HTML 类名，默认为summary.
使用
配置好插件后，在 GitBook 的书籍目录下运行以下命令，生成目录：
$ gitbook serve
示例代码
下面是一个简单的示例代码，展示了如何使用 gitbook-plugin-summary-generator 来生成目录：
-- -------------------- ---- -------
-
-------- --- ---------
-------------- ------ ----------
--------- -------
------------ ----- - -----
----------- --------
---------- -------------------------------------
---------------- -
-------------------- -
--------------- ------
-------- --
-------- ---------
-
--
----------- -
-
-------- ------
------- -------------
--
-
-------- ------
------- -------------
-
-
-结语
本文对 npm 包 gitbook-plugin-summary-generator 的使用进行了详细的介绍。通过本文的学习，相信大家对 gitbook-plugin-summary-generator 这个插件有了更深入的认识，这对我们进一步提高 GitBook 的使用效率和书籍质量都是有指导意义的。
最后，请注意我们需要合理应用知识，勿将其用于不当用途。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056c8d81e8991b448e6058