项目初始化
Node 版本 10.23.0 以下版本可使用。(可使用nvm版本控制)
-
进入项目文件夹
-
gitbook init
-
npm init
-
在
package.json
文件的scripts
中配置如下的脚本命令:"scripts": { "serve": "gitbook serve", "build": "gitbook build" }
-
npm run serve
本地运行
内容配置
-
GitBook 使用文件
SUMMARY.md
来定义书本的章节和子章节的结构。文件SUMMARY.md
被用来生成书本内容的预览表。 -
名字->路径
-
# 概要 - [第一章](part1/README.md) - [1.1 第一节](part1/writing.md) - [1.2 第二节](part1/gitbook.md) - [第二章](part2/README.md) - [2.1 第一节](part2/feedback_please.md) - [2.2 第二节](part2/better_tools.md)
-
任何在文件夹下的文件,在最后生成电子书时都会被拷贝到输出目录中,如果想要忽略某些文件,和 Git 一样, Gitbook 会依次读取
.gitignore
,.bookignore
和.ignore
文件来将一些文件和目录排除。 -
Gitbook 在编译书籍的时候会读取书籍源码顶层目录中的
book.js
或者book.json
,这里以book.json
为例,参考 gitbook 文档 可以知道,book.js
常用的配置如下。module.exports = { // 书籍信息 title: 'nju计网手册', description: '描述', isbn: 'xxxx', author: 'thdlrt', lang: 'zh-cn', // 插件列表 plugins: [], // 插件全局配置 pluginsConfig: {}, // 模板变量 variables: { // 自定义 }, };
插件
-
所有插件的命名都是以
gitbook-plugin-xxx
的形式 -
安装并添加到配置文件
-
npm install gitbook-plugin-search-pro
-
{ plugins: ['search-pro']; }
-
部署到github
gitbook build
编译为静态网页(book_文件夹)- 对内容分离保存,全部文件(包含源码)推送到master分支
- book_内的内容push到gh-pages分支,用于部署静态网页
- 在设置中选择参数