Gitbook 简单使用教程
- 上篇文章已经说了如何在Windows上安装gitbook,本篇主要描述快速入门gitbook,对于一般新手已经足够。
- 根据目录生成图书结构 在根目录下需要有README.md 和SUMMARY.md 文件
- README.md 文件相当于一本Gitbook的简介
- SUMMARY.md 相当于一本书的目录入口
- gitbook基础使用
- 创建一个文件夹 test_gitbook
- 创建一个README.md文件
- 创建一个SUMMARY.md文件中添加内容:
* [简介](README.md)
* [第一章](chapter1/README.md)
- [第一节](chapter1/section1.md)
- [第二节](chapter1/section2.md)
* [第二章](chapter2/README.md)
- [第一节](chapter2/section1.md)
- [第二节](chapter2/section2.md)
* [结束](end/README.md)
-
在当前目录中输入命令
gitbook init
则会在test_gitbok目录中创建相应的文件和文件夹 -
终端输入:
gitbook help
可以查看相关命令 -
本地预览自动生成输入命令:
gitbook serve
如下图提示,则生成成功
- 浏览器输入:http://localhost:4000 可以进行访问
- 在目录下也会生成一个_book目录,这个目录中的文件,可以直接点击使用,相当本地html
- 访问在线地址,点击章节一切正常。如果是高版本的gitbook 此时可能会出现问题
-
build参数生成文件,输入命令:
gitbook build
则会在当前文件夹生成静态电子书_book,不会在线预览。当编写笔记,建议使用在线预览,可以实现试试预览,方便排版。 -
注意
gitbook 在 3.0.0之后的版本
问题:可能出现在本地打开时,当点击左边的章节(是README.md生成的index.html时),没有打开index.html,而是打开了文件目录
问题原因:因为3.0.0版本之后,不支持localhost打开章节的index.html -
以上步骤已经可以进行gitbook电子书的编写,如果需要添加额外插件可以参考
【Gitbook】实用配置及插件介绍
插件安装
- 在根目录(即与SUMMARY.md同级的目录)下的配置文件 book.json(如果没有则新建)中添加插件配置如下:
{
“plugins”:[“toggle-chapters”]
}
npm install gitbook-plugin-toggle-chapters
(此时gitbook的根目录下的node_modules文件夹中已经有了该插件了,该插件提供章节收缩功能)
- 提供可以调整左边章节和右边内容的
{
“plugins”: [“splitter”]
}
npm install gitbook-plugin-splitter
-
安装页脚插件:
npm install gitbook-plugin-tbfed-pagefooter
“plugins”: [
“tbfed-pagefooter”
],
“pluginsConfig”: {
“tbfed-pagefooter”: {
“copyright”:“Copyright © xy 2018”,
“modify_label”: “修订时间:”,
“modify_format”: “YYYY-MM”
}
} -
安装插件 gitbook install 可以直接下载book.json目录下的插件
-
其他常见book.json
“title”: “demo”,//标题
“description”: “demo”,//文档描述
“language”: “zh”,//选择编辑的语言环境
注意:多个插件要有逗号分隔