GitBook 使用教程
GitBook 写完编译后可以生成静态页面发布到博客上.
GitBook依赖(前置条件)
准备工作:先安装依赖
安装Node.js
- 安装 Node.js
参考: https://nodejs.org/en 命令:
$ node -v
其它教程: Node.js 安装
安装 GitBook
安装GitBook命令:
$ npm install gitbook-cli -g
$ gitbook -V
其它教程: Gitbook安装
使用编辑器(推荐)
- VsCode
- Typora
使用GitBook
开始工作
初始化命令:
$ gitbook init 自动创建 README.md 和 SUMMARY.md 这两个文件,README.md 是说明文档,而 SUMMARY.md 是书的章节目录 $ gitbook serve 运行该命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件. 在浏览器地址栏中输入 http://localhost:4000 便可预览书籍。
编译命令:
$ gitbook build 生成网页而不开启服务器
目录结构
- book.json 该文件主要用来存放配置信息
title 本书标题 author 本书作者 description 本书描述 language 本书语言,中文设置 "zh-hans" 即可 gitbook 指定使用的 GitBook 版本 styles 自定义页面样式 structure 指定 Readme、Summary、Glossary 和 Languages 对应的文件名 links 在左侧导航栏添加链接信息 plugins 配置使用的插件 pluginsConfig 配置插件的属性
- SUMMARY.md
这个文件主要决定 GitBook 的章节目录,它通过 Markdown 中的列表语法来表示文件的父子关系
插件
GitBook 有 插件官网,默认带有 5 个插件,highlight、search、sharing、font-settings、livereload,如果要去除自带的插件, 可以在插件名称前面加 -
"plugins": [ "-search" ]
- 添加 plugin-github
{ "plugins": [ "github" ], "pluginsConfig": {
"github": { "url": "https://github.com/your/repo" }
} }
在终端输入 gitbook install ./ 即可安装。 如果要指定插件的版本可以使用 plugin@0.3.1。