文本从介绍gitbook是什么,一直到gitbook的使用,直到最后,如何部署gitbook?
本文将从以上几个维度去介绍gitbook。
1、是什么?
GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。
所以我更喜欢把 GitBook 定义为文档格式转换工具。
但是 GitBook又与Markdown和Git息息相关,只有将它们使用起来,才可以发挥出来更大的威力!
因此,我们这边一般使用的合适的markdown的编辑工具获得好的写作体验;
然后通过git来管理书籍内容的变更,并且将其托管到云端,实现多人协作;
再通过GitBook管理文档,制作相关的电子书
2、如何安装?
当我们决定使用GitBook的时候,就需要知道如何搭建gitbook环境?
因为GitBook是基于 Node.js,所以需要首先安装node.js,找到对应的版本,然后安装就可以了。
由于node.js一般都会默认安装npm,所以我们不用单独的去安装,可以执行下面的命令安装GitBook:
安装完成之后,可以使用下面的查看出当前安装的gitbook的版本命令。
➜ test gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3
还有markdown的编辑工具typora的下载地址:https://typora.io/
git的下载地址:https://git-scm.com/downloads
其中markdown可能需要翻墙,可以自行解决哦~ 哈哈~
3、如何使用gitbook?
上面聊了这么久,现在开始可以准备使用gitbook来写文章啦~
1、在硬盘当中 新建一个test_gitbook文件夹。
2、在test_gitbook文件夹下面,执行下面的命令,然后会在当前文件夹下生成出两个文件 README.md(书籍的介绍写在这个文件里)和SUMMARY.md(书籍的目录结构在这里配置)。
3、使用typora来编辑SUMMARY.md文件,添加相关的目录,然后在当前文件夹下面执行,就可以生成对应的目录文件,再使用markdown进行编写。
4、接着我们执行来预览这本书籍,执行命令后会对 Markdown 格式的文档进行转换,默认转换为 html 格式,最后提示 “Serving book onhttp://localhost:4000”。
5、你可以执行命令构建书籍,默认将生成的静态网站输出到 _book 目录。实际上,这一步也包含在里面,因为它们是 HTML,所以 GitBook 通过 Node.js 给你提供服务了。
4、linux服务器部署Gitbook
当我们gitbook写完之后,使用可以在目录当中,生成一个_book的静态网页资源,里面存在index.html文件,这个也就是入口文件。然后在nginx部署当中的conf文件写如下配置即可
server{
listen 4000;
server_name localhost;
location / {
root /home/work/gitbook/_book;
index index.html;
try_files $uri $uri/ =404;
}
}
然后重启nginx即可使用localhost去访问,此处有个注意事项:服务器的4000端口需要开放。
领取专属 10元无门槛券
私享最新 技术干货