一、关于gitbook

gitbook是一款写书软件,可以很方便的把一系列markdown文本整合成一个书籍网站发布。

以下是一个预览页面:

gitbook的名字中虽然有git,但是实际上和git没有任何关系。就像java和javascripts一样。

二、安装gitbook

gitbook实际上是一个node.js工具,因此使用前要先安装node.js,或者直接安装npm工具:

sudo apt install npm

确认nodejs和npm命令可用:

> node -v
v10.16.0
> npm -v
6.9.0

安装gitbook:

sudo npm install gitbook-cli -g

三、使用gitbook生成第一本书

在要写书的目录内,执行gitbook init即可初始化一本书:

image.png

默认会生成两个文件:README.mdSUMMARY.md。其中README.md文件是对书籍整体的介绍,而SUMMARY.md中记录了章节目录信息。

发布第一本书

使用gitbook serve可发布书籍信息,执行后默认在本地搭起一个服务端监听4000端口:

在浏览器访问4000端口即可预览:

执行gitbook serve后会在当前目录下生成一个_book的文件夹,文件夹里面保存了发布书籍的静态文件资源。

> ll _book/
total 12
drwxrwxr-x. 10 maqian maqian  270 Sep 13 21:04 gitbook
-rw-rw-r--.  1 maqian maqian 6172 Sep 13 21:04 index.html
-rw-rw-r--.  1 maqian maqian  568 Sep 13 21:04 search_index.json

静态文件也可以直接使用nginx或者其他web服务器来发布,gitbook serve实际上是先生成静态文件,然后再托管这些文件作为web服务器。

如若不想使用gitbook serve提供的服务,可以直接使用gitbook build编译出静态文件:

imagedbe8c5cede9c3529.png

三、目录结构

3.1 SUMMARY.md

默认情况下SUMMARY.md中的内容:

# Summary

* [Introduction](README.md)

3.1.1 添加子目录

效果:

imagee5e99079a08eed2b.png

SUMMARY.md:

# Summary

* [Introduction](README.md)
* [Css](css/README.md)
    * [css1](css/css1.md)
    * [css2](css/css2.md)
* [Javascripts](js/README.md)
    * [js1](js/js1.md)
    * [js2](js/js2.md

3.1.2 section分块

效果:

imagebc967a125dd2b3a8.png

SUMMARY.md:

# Summary

* [Introduction](README.md)

## Part I

* [Css](css/README.md)
    * [css1](css/css1.md)
    * [css2](css/css2.md)

## Part II

* [Javascripts](js/README.md)
    * [js1](js/js1.md)
    * [js2](js/js2.md)
最后修改:2019 年 09 月 14 日
如果觉得我的文章对你有用,请随意赞赏