什么是 npm 包？
npm 是一个包管理器。它被用来下载并安装一些包含可重复使用的 JavaScript 代码的软件。这些包大多数是可以在浏览器或服务器端运行 JavaScript 的模块。
npm 包将代码的发布和管理变得更加容易，并且允许广泛的开发者社区共享代码。包可以像搭积木一样拼接在一起，来构建各种复杂的应用程序。
什么是 gitbook-plugin-wiki-toc？
gitbook-plugin-wiki-toc 是一个用于 GitBook 的插件，可以帮助你自动生成页面的目录。这个插件可以从页面标题中自动生成目录，并跳转到页面上的对应标题。
该插件被广泛用于写电子书、技术文档和博客等场景中，帮助读者更快速、更方便地浏览阅读文章。
如何使用 gitbook-plugin-wiki-toc？
- 安装 GitBook
首先，你需要安装 GitBook，以便可以在本地运行 GitBook 服务器以处理文章。
$ npm install -g gitbook-cli
- 初始化 GitBook 项目
再次运行以下命令初始化 GitBook 项目：
$ gitbook init
接下来运行 GitBook 服务器：
$ gitbook serve
你会看到 GitBook 服务器在 http://localhost:4000 上运行，并加载了默认主题和样式。
现在你可以开始编写文档，这是引入 gitbook-plugin-wiki-toc 的最佳方法。
- 安装 gitbook-plugin-wiki-toc
使 GitBook 可以使用 gitbook-plugin-wiki-toc 插件所需要的第一步，是安装插件到你的项目中：
$ npm install --save-dev gitbook-plugin-wiki-toc
通过运行以上命令，你可以安装一个有用的 npm 包，并将其保存为开发依赖项。这个依赖项需要运行时，因为它是 GitBook 需要的一部分。
- 启用 gitbook-plugin-wiki-toc
如果你已经在使用 GitBook 运行 gitbook serve 命令，需要暂停服务器，然后打开本地的 book.json 文件。
{
"plugins": ["gitbook-plugin-wiki-toc"]
}在你的 book.json 文件中添加上述内容，即可启用 gitbook-plugin-wiki-toc 插件。修改文件保存之后，重新启动 GitBook 服务器。
- 编写 Markdown
现在，你可以在 Markdown 中使用 # 标题和 ## 子标题来创建文档的标题和子标题。GitBook 将会使用这些标题来构建页面的目录。
-- -------------------- ---- ------- - --- -- ---- ---------- -- ---- ---------- - --- ---
- 运行 GitBook 服务器
运行 gitbook serve 命令，访问 http://localhost:4000 即可开启 GitBook 服务器，并打开 book.json 文件所配置的主题样式。
- 漂亮的目录
现在，在页面的侧边栏中，可以看到页面的目录已经在插件的帮助下生成了，而且是相当清晰漂亮的。
示例代码
以下是示例代码：
-- -------------------- ---- ------- - ----- -- -- -------- -- --- --- --- --------- --- --- --------- -- --- --- --- --------- --- --- ---------
总结
本文介绍了 npm 包 gitbook-plugin-wiki-toc 的使用方法，包括安装、启用、编辑 Markdown 文件等等。这些步骤可以帮助你快速地创建一本电子书或技术文档，并且可以为读者提供更清晰、更方便的页面目录。
通过使用 gitbook-plugin-wiki-toc，您可以去除人工编写目录的繁琐过程，同时也可以更好地让您的网站排版更加整洁有序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005600f81e8991b448ddecd