title

date

comments

categories

tags

permalink

gitbook的常用方法

2020/2/2

true

2.3

必备技能

gitbook的使用方法

gitbook是一款非常方便的"写书"软件,Document Everything!一切皆文档！

一句话道出本质

转换markdown文档成静态HTML页面的工具.

1、安装方法

首先安装nodejs, 到官网下载一路点下一步即可。
安装gitbook,命令:npm install gitbook -g npm很可能会失败，推荐使用淘宝npm镜像 npm install -g cnpm --registry=https://registry.npm.taobao.org 之后就可以使用cnpm代替npm了。

2、使用方法

常用的命令:

  gitbook init, 初始化(一般在您想要保存您的文档的目录下执行)
  gitbook build, 构建，把你写的markdown文档转化成html.
  gitbook serve,启动web服务,访问localhost:4000就是你写的书了

具体说明:

总的来说gitbook就是通过把你写的markdown文档，转换成静态html文档，之后挂在支持gh-pages的源代码托管网站上(如github,后面就用github做例子来说明)，就可以像一个blog一样在线浏览了,github的地址一般是:yourname.github.io/仓库名/
gitbook在执行build命令之后，会在当前目录生成一个_book文件夹，文件夹内部就是用你 写的markdown生成的静态网站。把这个文件夹里的所有文件上传到你的github仓库的gh-pages分支(没有的话就新建，名字不能错)就可以了。

在你指定的文件夹下执行gitbook init 命令之后，会生成README.md和SUMMARY.MD两个文件，readme.md里面可以写上你的说明，
SUMMERY.MD就是你要写的书(或者叫博客)的目录,就像你现在看到的网页的左边那一列。
目录的语法如下

Summary



* [第一章](overview.md)
* [第二章](api_reference/README.md)
   * [第一节](../api_reference/indexing.md)
   * [第二节](../api_reference/object.md)



*号后面的空格不要少了。 其实就是普通的markdown文档的写法。不知道的可以参考官方文档。

小技巧:因为gh-pages分支对应着博客内容，但是master也需要管理，通常的做法是在本地维护两个文件夹.还可以通过shell脚本来完成.