Gitbook 是一款轻量级的文档编写工具，让我们可以方便的将 markdown 格式的文章生成为兼具可读性和美观的书籍。而 gitbook-summary-ex 则是一个 npm 包，使用它可以更加便捷地生成 Gitbook 的目录结构。在本篇文章中，我们将会介绍如何使用 gitbook-summary-ex 这个工具，同时通过实例代码进行演示。
安装 gitbook-summary-ex
首先，我们需要安装 gitbook-summary-ex ，你可以在 Node.js 环境下执行以下命令进行安装：
npm i -g gitbook-summary-ex
安装完成后，就可以在终端下使用 gitbook-summary-ex 命令了。
使用 gitbook-summary-ex
使用 gitbook-summary-ex 需要三个参数：-i 参数指定输入的目录，-o 参数指定输出的目录，-t 参数指定目录文件的模板。
下面我们将以一个名为 mybook 的目录为例来演示如何使用 gitbook-summary-ex：
- 在
mybook目录下，新建一个SUMMARY.md文件，编写书籍的目录结构，例如：
-- -------------------- ---- ------- - -- - ----------------- - ------------------------- - --- ------------------------ - --- ------------------------ - ------------------------- - --- ------------------------ - --- ------------------------
- 在
mybook目录下，执行以下命令：
gitbook-summary-ex -i ./ -o ./ -t default
执行成功后，你会在 mybook 目录下看到一个生成的 _summary.md 文件，其内容和你编写的 SUMMARY.md 相同。
我们可以使用 gitbook 命令将 book 的 html 生成出来：
gitbook build ./ ./_book
然后打开 ./_book/index.html 可以看到我们编写的 book 内容。
模板参数
gitbook-summary-ex 目前提供了两种模板：
- default
default 模板为默认的目录结构，与 Gitbook 官方文档的目录结构一致。
- el-tree
el-tree 模板为 element-ui 中提供的树形目录结构，具有层次感。
下面为 el-tree 模板实例：
-- -------------------- ---- ------- - -- --- ------- - ----------------- - ------------------------- - --- ------------------------ - --- ------------------------ - ------------------------- - --- ------------------------ - --- ------------------------ ---
生成的目录结构将会是这样的：
以上就是 gitbook-summary-ex 的使用方法，通过使用它你可以更加方便的维护你的 Gitbook 目录结构。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a730d0927023822609