GitBook
GitBook 提供以下功能。
- 支持 markdown 语法
- 自动构建文档网站
- 丰富的插件来拓展网站,比如:搜索,代码高亮等
- 支持 git 进行文档项目管理
什么是 GitBook
GitBook 是一个文档编辑工具。它的功能类似金山的 WPS,微软的 Office 中的 Word 文档编辑工具。它可以用来写文档、建表格、插图片、生成 pdf 。虽然这些功能不一定有 WPS、Office 做得好,但是它可以用文档生成一个网站,让更多的人了解到你书写的内容。从此,不再为共享文档给他人后,如何时时同步而烦恼。实例效果如下:
GitBook 官网注册登录后,可在线创建、编辑和发布文档。线下提供离线编辑工具 GitBook Editor。但是本文档主要讲解的是 ,如何利用 GitBook 的命令行工具 gitbook-cli 来创建、预览及发布文档。
安装 gitbook-cli
NodeJs
安装 NodeJs 是因为我们要使用其提供的 npm 包管理工具来下载安装 gitbook-cli
。从 NodeJs 官网 下载最新版本安装即可(版本要求 V4.0.0 及以上)。
安装 gitbook-cli
运行以下命令进行安装
npm install gitbook-cli -g
gitbook init 项目初始化
首先新建如下目录结构