GitBook是一个基于Node.js的命令行工具,可使用Github/Git和Markdown来制作电子书(其实主要是写用户手册,API使用文档之类的啦)。总之,程序员必备技能,这里就不多强调重要性了!markdown语法请自行google,本文只简单介绍一些gitbook的目录结构和简单用法。
安装gitbook-cli
1 | npm install gitbook-cli -g |
安装好之后,可以大概了解下其功能和命令
1 | gitbook help |
制作电纸书
初始化
首先创建一个电子书的目录,比如叫做book。然后进入到book目录下,执行以下操作。
1 | $ gitbook init |
执行以上命令会自动创建电纸书必须的README.md和SUMMARY.md文件。
- README.md文件是你作品的介绍
- SUMMARY.md是你作品的目录结构
添加内容
初始化之后,我们就可以往book目录下添加子目录和文件(需要按照markdown语法来写内容)了,下面是添加了二级目录和内容后的结构。
1 | $ tree |
对应的,我们需要修改SUMMARY.md
, 从而建立电子书的目录层次和到具体文章的链接(请注意这里是使用的相对地址,而不是绝对地址)。
1 | $ cat SUMMARY.md |
运行服务
1 | # 默认启动,使用4000端口 |
运行起来后,可以在浏览器中通过 http://localhost:4000 来访问启动后的服务。[注意]
: 默认启动使用的是4000端口,当然我们也可以通过参数 -p 来指定使用的接口。
1 | # 通过-p指定端口 |
发布
撰写完成后,我们可以生成静态网站用来发布。
1 | gitbook build |