GitBook可以在您的计算机上用于构建本地书籍,,可以本地预览
安装gitbook
环境要求:
安装GitBook,您的系统需要安装NodeJS
(推荐v4.0.0及以上版本)
下载地址
使用npm安装
安装GitBook的最佳方法是通过NPM。在终端提示符(cmd命令行)下,只需执行以下命令即可安装GitBook:
npm install gitbook-cli -g
gitbook-cli是一个在同一系统上安装和使用多个版本的GitBook的实用程序。它将自动安装所需版本的GitBook来构建一本书。
安装成功后,执行gitbook -V
查看版本信息。
至此,gitbook安装成功
GitBook 基本使用
gitbook 的基本用法非常简单,基本上就只有两步:
- 执行
gitbook init
初始化书籍目录 - 执行
gitbook serve
编译书籍
下面将结合一个非常简单的实例,来介绍 gitbook 的基本用法。
初始化 - gitbook init
- 首先,编辑文件内容
- 在书籍项目根目录执行
gitbook init
命令初始化文件夹,会自动生成两个必要的文件 README.md 和 SUMMARY.md(这两个文件是GitBook制作电子书的必要文件)。
- README.md: 书的介绍文字,如前言、简介,在章节中也可做为章节的简介。
- SUMMARY.md: 定制书籍的章节结构和顺序。
- 我的文件目录树
执行tree \f
命令可以查看文件目录(包含文件夹和文件)
├─GitBook.md
├─README.md
├─SUMMARY.md
├─chapter1
│ ├─file1.md
│ └─file2.md
└─chapter2
└─other.md
- 编辑目录文件——SUMMARY.md
目录的语法如下:* [显示的目录名](文件夹/文件名#标题id)
这里的id有个规则,基本上是和标题名一致:-
-
/中文字体/数字/小写字母格式不变 - 大写字母改成小写
- 大部分特殊符号直接省略不写
- 空格用符号
-
代替
-
# Summary 示例目录
* [Introduction](README.md)
* [GitBook](GitBook.md)
* [安装GitBook](GitBook.md)
* [操作环境](GitBook.md#操作环境)
* [NodeJs安装](GitBook.md#nodejs安装)
* [初始化](GitBook.md#初始化)
* [预览](GitBook.md#预览)
* [文件一](chapter1/file1.md)
* [个性化配置](chapter1/file1.md#个性化setting)
* [插件](chapter1/file1.md#插件)
* [文件二](chapter1/file2.md)
* [其他](chapter2/other.md)
预览书籍 - gitbook serve
书籍目录结构创建完成以后,就可以执行gitbook serve
命令来编译和预览书籍了。
- 编译:命令行中执行
gitbook serve
gitbook serve
命令实际上会首先调用gitbook build
编译书籍,完成以后会打开一个 web 服务器,监听在本地的 4000 端口。 - 预览:浏览器访问 http://localhost:4000 如图:
个性化使用 - GitBook插件
- 在书籍目录下新增
book.json
文件,然后增加插件代码。
例如增加设置logo插件,在book.json
中添加以下代码:
{
"plugins": [ "insert-logo" ]
"pluginsConfig": {
"insert-logo": {
"url": "images/logo.png",
"style": "background: none; max-height: 30px; min-height: 30px"
}
}
}
我写了一篇关于GitBook插件使用的文章。
附700个插件:官方地址
- 保存
book.json
,执行gitbook install
安装,或者执行npm install gitbook-plugin-insert-logo
如果报错说明json文件可能有语法问题
两种安装方式介绍:- 使用gitbook-cli 方式,即
gitbook install
,把book.json
中所有的插件列表都安装一遍,如果修改了插件的配置文件,会被覆盖 - 使用NPM安装,只是单独安装一个插件,不影响其他插件
- 使用gitbook-cli 方式,即
- 执行
gitbook serve
预览 - 其他插件:
官方获取插件地址:https://plugins.gitbook.com