简介
Gitbook 是一款基于 Node.js 的在线文档编写工具,它支持 Markdown 和 AsciiDoc 两种语言进行书写,并能够将写好的文档生成静态网页或电子书。使用 Gitbook 制作文档,可以轻松地进行版本管理、团队协作和文档发布等操作。
本文将介绍如何使用 npm 包 gitbook 来创建和管理文档项目,以及如何生成静态网页或电子书。
安装 Gitbook
在使用 Gitbook 前,需要先安装 Node.js 和 npm。安装完成后,在命令行工具中执行以下命令来安装 Gitbook:
--- ------- ----------- --
-g
参数表示全局安装,这样就可以在任意目录下使用 Gitbook 命令了。安装完成后,可以执行 gitbook --version
命令来检查是否安装成功。
创建文档项目
创建文档项目有两种方式:手动创建和使用模板。
手动创建
在命令行中进入到要创建文档项目的目录,执行以下命令:
------- ----
执行后会自动创建一个名为 README.md
的文件和一个名为 SUMMARY.md
的目录结构文件。其中,README.md
文件是文档的首页,SUMMARY.md
文件定义了文档的目录结构。
使用模板
gitbook-cli 内置了一些常用的文档模板,可以直接使用。以官方提供的模板 docs
为例,执行以下命令来快速创建一个文档项目:
------- ---- ---------------
执行后会自动生成一个包含了常用页面和结构的文档项目。
编写文档
Gitbook 支持 Markdown 和 AsciiDoc 两种语言进行书写,并提供了一些扩展语法。具体语法可以参考 Gitbook 的官方文档。
在编写文档时,需要编辑 README.md
文件和 SUMMARY.md
文件。其中,README.md
文件是文档的首页,可以用 Markdown 语言编写,例如:
- ---- ------- ------- ---
而 SUMMARY.md
文件则定义了文档的目录结构,可以用 Markdown 语言编写。例如:
- ------- - ------------------------- - -------- ---------------------- - -------- ---------------------------- - -------- ---------------------------- - -------- ---------------------- - -------- ---------------------------- - -------- ----------------------------
在 SUMMARY.md
文件中,每个目录项对应一个文档章节。可以通过缩进来定义子章节。
生成静态网页或电子书
当编写完成文档后,可以使用 Gitbook 命令将其生成为静态网页或电子书。
生成静态网页
执行以下命令来将文档生成静态网页:
------- -----
执行后会在当前目录下自动生成一个 _book
目录,其中包含了所有生成的 HTML、CSS、JS 和图片等文件。可以将整个 _book
目录上传到 Web 服务器上,即可访问生成的静态网页。
生成电子书
执行以下命令来将文档生成电子书:
------- --- -- -- --- ----- ------- ---- -- -- ---- ----- ------- --- - ----------------------------------------------------------- -------- ---------------------------------------------------------------------------------------