前言
在前端开发中,我们经常使用 GitBook 作为文档工具,方便我们写作、整理知识点以及输出文档。使用 GitBook 的过程中,我们就不得不提到一款 npm 包 - gitbook-raw-cli,它是 GitBook 的本地 CLI 工具,可以帮助我们快速地初始化、编写和构建文档。
本文将对 gitbook-raw-cli 的基本使用进行详细介绍,以及一些高级用法的介绍,希望可以帮助您更好地使用 GitBook。
安装
gitbook-raw-cli 是一个 npm 包,我们可以通过以下命令进行安装:
npm install -g gitbook-raw-cli
安装完成后,我们可以使用以下命令查看是否安装成功:
gitbook-raw --version
如果输出了版本号,则证明已经成功安装:
1.0.0
使用方法
初始化文档
在使用 gitbook-raw-cli 之前,我们需要先新建一个文件夹,作为 GitBook 的根目录。在该文件夹下使用以下命令,即可初始化一个 GitBook 项目:
gitbook-raw init
命令执行完成之后,会生成以下目录结构:
├── README.md ├── SUMMARY.md └── docs ├── chapter-01.md └── chapter-02.md
其中:
- README.md:项目的简介和介绍,也可以作为项目的首页。
- SUMMARY.md:生成的文档目录和链接。
- docs:存放所有章节的 Markdown 文件。
添加章节
在初始化之后,我们可以开始书写自己的内容。在 docs 目录下,新建一个 Markdown 文件,命名规则为 chapter-xx.md
。
在新增章节之后,我们需要在 SUMMARY.md 文件中添加新的目录链接。在 SUMMARY.md 文件中添加新链接的规则如下:
- [章节名称](章节文件路径)
例如,我们新增了一个名为“hi”的章节,并将其保存为 chapter-03.md
,则需要在 SUMMARY.md 中添加以下内容:
- [HI](docs/chapter-03.md)
构建文档
在完成书写之后,我们需要将 markdown 文件构建成 HTML 页面,以输出文档。我们可以使用以下命令构建文档:
gitbook-raw build
命令执行完成之后,在项目的根目录下会生成一个 _book
文件夹,其中包含了生成的 HTML 文件和相关资源文件。
预览文档
在完成文档构建之后,我们可以使用以下命令预览文档:
gitbook-raw serve
命令执行完成之后,在浏览器打开 http://localhost:4000
,即可查看生成的文档。
高级用法
使用主题
gitbook-raw-cli 默认使用了 GitBook 的默认样式,但是我们可以通过使用主题来改变样式。我们可以通过以下命令安装一款主题:
npm install gitbook-plugin-theme-custom -D
安装完成之后,在项目的根目录中,新建一个 book.json
文件。在该文件中,我们可以配置 GitBook 的相关设置:
{ "title": "My GitBook", "theme": "theme-custom" }
其中,“theme”用于指定使用的主题名称。然后,在项目根目录下使用以下命令,重新构建文档:
gitbook-raw build
打包 GitBook
通过使用 gitbook-raw-cli 能够将 Markdown 文件构建为 HTML 页面,但如果我们需要将这些页面打包在一起,则需要使用其他工具。在这里,我们可以使用 Gulp 工具来打包 GitBook。
在可以打包之前,我们需要先安装以下依赖包:
npm install gulp gulp-gitbook gulp-util gulp-autoprefixer gulp-changed --save-dev
然后,我们在项目根目录下创建一个 gulpfile.js
文件,并输入以下代码:
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------- - ------------------------ ----- ---- - --------------------- ----- ------------ - ----------------------------- ----- ------- - ------------------------ -------------------- ---------- - ------ ---- ----------------- ---------------- ------------ --------- -------------------- --------- ------ - ---------- --------- -- ---- --- ----------------------- - ----------- ----------------------- --- --------------------------- ---
该 gulpfile.js 文件定义了一个名为“default”的任务,用于自动构建 GitBook。
命令执行完成之后,在 ./dist
文件夹下,我们就可以找到生成的 HTML 页面和相关的 Assets 资源文件。
结语
通过使用 gitbook-raw-cli,我们可以很方便地使用 GitBook 快速创建文档,并将文档构建成 HTML 页面输出。同时,我们也可以通过一些高级用法来定制我们的 GitBook,以达到更好的使用效果。希望本文对您学习 GitBook 和 gitbook-raw-cli 有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055b0181e8991b448d8a90