关于gitbook

gitbook 是一款类似于word文档的编辑工具,他的优势在于能够使用git管理工具进行管理,这也意味着他可以更方便的进行多人协作文档管理,编辑,记录每个人的每一次改动

1,首先安装,基于node进行安装

npm i gitbook-cli -g

gitbook -v(查看是否安装成功)

2,选择一款编辑器

可以用 VsCode、Typora 等自己喜欢的来编辑。

3,gitbook 初始化仓库

选择或新建一个文件夹作为gitbook的仓库

gitbook init 

成功后生成README.md 和 SUMMARY.md 这两个文件,README.md ,就是说明文档,而 SUMMARY.md 就是书的章节目录,如下所示:

 

 

 4,SUMMARY.md的编辑

* [前言](README.md)
* [第一章](Chapter1/README.md)
    * [第1节:vue的生命周期](Chapter1/vue的生命周期.md)
    * [第2节:vue的watch属性](Chapter1/vue的watch属性.md)
    * [第3节:vue的计算属性](Chapter1/vue的计算属性.md)
    * [第4节:vue的双向绑定](Chapter1/vue的双向绑定.md)
* [第二章](Chapter2/README.md)
* [第三章](Chapter3/README.md)
* [第四章](Chapter4/README.md)

5,保存后再次更新编译

gitbook init 会生成新的文档

6,在线查看 

gitbook serve

生成 http://localhost:4000  预览路径

 

 

运行该命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件,

更改文档后再次执行gitbook init 重新编译新的html文件

执行gitbook serve 生成新的链接查看

7,生成_book文件夹时会伴随生成book.json配置文件,里面是关于文档的一些基本信息,文档配置等

如果没有生成,可以自己创建配置,其目录等级和SUMMARY.md文件同级

8,当然我们也可以使用下面命令来生成网页而不开启服务器

gitbook build

 

posted on 2020-06-01 12:41  jswzy  阅读(325)  评论(0)    收藏  举报