MLi's Blog

Gitbook学习笔记(1):利用gitbook命令行工具创建和编译书籍

需要用到的软件

  • nodes.js
  • gitbook命令行工具(用于创建和编译书籍,不用手动下载,安装完nodes.js通过命令行工具自动安装);
  • Markdown语法编辑器(用于编辑书本的内容和格式。在线或者离线均可,可以参考:Markdown 编辑器推荐);

gitbook命令行工具安装

安装教程主要参考:SIOgitBook

  1. 下载node.js的源文件并安装。安装完以后在系统CMD里输入:node -v查看node.jsb版本,以校验是否安装成功。

  2. 系统cmd里安装gitbook命令行工具: npm install gitbook-cli -g; 然后输入gitbook -V (V大写)查看gitbook命令行工具版本,以校验gitbook是否安装成功。返回版本号则说明安装成功。 如果需要卸载gitbook,则可以npm uninstall -g gitbook

创建和编译一个只有目录的书籍

创建书籍目录

在本地电脑上新建一个文件夹,比如test;然后CMD下进入该文件夹,输入

gitbook init

会在该文件夹下创建两个基本文件README.md和SUMMARY.md。其中README.md为书本的介绍,用编辑器打开以后默认内容为:

# Introduction

SUMMARY.md为书籍的框架文件,用编辑器打开以后默认内容为:

# Summary * [Introduction] (README.md)

其中# Summary为固定格式,下一行声明的是生成一个标题为Introduction的章,里面的具体内容由README.md文件给出。

编辑书籍目录和框架

系统默认的SUMMARY.md里的README.md实际上是书籍的介绍文件,因此我们自己撰写的时候可以另外创建一个.md文件(比如chap1_body.md)然后将Summary.md文件里的第二行改为 * [Introduction] (chap1_body.md)

如果一个章节里有好几个小节,每个小节再由不同的.md文件给出,则可以参考下例修改SUMMARY.md源代码为

1
2
3
4
5
# Summary
* [基本安装](howtouse/README.md)
- [Node.js安装](howtouse/Nodejsinstall.md)
- [Gitbook安装](howtouse/gitbookinstall.md)
- [Gitbook命令行速览](howtouse/gitbookcli.md)

这时候需要再次执行gitbook init,这样在当前目录下会创建名howtouse的子文件夹,该子文件夹下有README.md、Nodejsinstall.md、gitbookinstall.md和gitbookcli.md四个文件。值得注意的是,SUMMARY.md里

  • ] 和 ( 中间不能有空格
  • [ 和前面的*和-要有空格。
  • 运行完gitbook init,文件夹内已有的文件不会被覆盖,也不会被删除。

否则不能创建成功。

编辑书籍的内容

上一小节里已经创建了书籍的框架,接下来就需要采用Markdown编辑器进行编辑添加内容到Nodejsinstall.md、gitbookinstall.md和gitbookcli.md、README.md里。

编译生成和预览书籍

最后需要在系统CMD下再次运行gitbook命令生成书籍,

生成服务器?:gitbook serve 最后在浏览器网页地址栏输入http://localhost:4000/进行预览

生成静态网页:gitbook build