GitBook 工具链是一个使用 Git 和 Markdown 来构建书籍的工具。它可以将书输出很多格式:PDF,ePub,mobi或者输出为静态网页。
文档:https://chrisniael.gitbooks.io/gitbook-documentation/content/
GitBook.com 是一个使用工具链来创建和托管书籍的在线平台 (www.gitbook.com)。
安装:
npm install --save-dev gitbook-cli
使用:
- 新建一个文件夹;
- 打开命令行,cd到这个文件夹下,执行
gitbook init
进行初始化,执行完成后,文件夹下会生成两个文件:README.md
和SUMMARY.md
; - 使用
gitbook serve
命令启动本地服务,命令执行结束后,可以在浏览器中打开http://localhost:4000
查看书籍; - 使用
gitbook build
命令构建,命令执行结束后,会在项目下生成_book的文件夹,此文件夹就是最终生成的项目;
README.md
:
README.md
是书籍的介绍。
从GitBook >2.0.0 起,就可以在 book.json 中定义某个文件作为README。
{
"structure" : {
"readme" : "myIntro.md"
}
}
SUMMARY.md
:
SUMMARY.md
用来定义书本的章节和子章节的结构。
SUMMARY.md
的格式是一个简单的链接列表,链接的名字是章节的名字,链接的指向是章节文件的路径。语法:英文中括号中是目录的名字,英文小括号中是路径。中括号和小括号之前没有空格。
写完目录之后再次执行gitbook init
,GitBook 会查找 SUMMARY.md
中描述的目录和文件,如果没有的话会自动创建。
Markdown语法:
GitBook默认使用Markdown语法。
标题:
# H1
## H2
### H3
#### H4
##### H5
###### H6
也可以使用 =
和 -
标记一级和二级标题。
我展示的是一级标题
=================
我展示的是二级标题
-----------------
区块:
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
> 区块引用
区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推:
> 最外层
> > 第一层嵌套
> > > 第二层嵌套
代码:
内嵌代码使用单个反引号包裹;代码块使用三个反引号包裹。
链接:
[链接名称](链接地址)
//或者:
<直接使用链接地址>
[菜鸟教程](https://www.runoob.com)
<https://www.runoob.com>
图片:
语法格式:开头一个感叹号;接着一个方括号,里面放上图片的替代文字;接着一个普通括号,里面放上图片的网址,最后还可以用引号包裹加上选择性的title属性的文字。
![属性文本](图片地址)
![属性文本](图片地址 "可选标题")
![RUNOOB](http://static.runoob.com/images/runoob-logo.png)
![RUNOOB](http://static.runoob.com/images/runoob-logo.png "RUNOOB")
列表:
Markdown 支持有序列表和无序列表。
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
有序列表使用数字并加上 . 号来表示:
1. 第一项
2. 第二项
3. 第三项
列表嵌套只需在子列表中的选项前面添加四个空格即可:
1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
表格:
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
可以设置表格的对齐方式:
-:
:设置内容和标题栏居右对齐。:-
:设置内容和标题栏居左对齐。:-:
:设置内容和标题栏居中对齐。
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
忽略文件和文件夹:
GitBook会读取 .gitignore
、.bookignore
、.ignore
文件来获取忽略的文件和目录的列表。