Gitbook 使用笔记

开篇日常立个flag……

全局安装

gitbook 基于 node.js，必须先安装 node

#安装
npm install gitbook -g
npm install gitbook-cli -g
#查看 gitbook 版本，如果没有安装则一并安装
gitbook -V

注：可能出现 node 版本过高无法安装 gitbook 的情况，可以下载一个 nvm 切换 node 版本，nvm 下载安装流程

本机使用的 node 版本是 v10.14.2

创建一本书

1、初始化

在空白文件夹下 CMD

gitbook init

文件夹下多了 README.md 和 SUMMARY.md 两个文件。

README.md 为书的介绍。

SUMMARY.md 为书的章节目录。

2、编写书的目录

修改 SUMMARY.md

# Summary

* [Introduction](README.md)
* [前言](readme.md)
* [第一章](part1/README.md)
    * [第一节](part1/1.md)
    * [第二节](part1/2.md)
    * [第三节](part1/3.md)
    * [第四节](part1/4.md)
* [第二章](part2/README.md)
* [第三章](part3/README.md)
* [第四章](part4/README.md)

然后再敲一次命令行

gitbook init

对应会生成文件

生成及启动

1、生成 _book

将书的内容生成 html 文件

gitbook build

2、本地启动

注：本地启动不依赖于上一步骤的生成。

gitbook serve

在浏览器地址栏中输入 http://localhost:4000 访问

3、对 Gitbook 进行配置

3.1、配置文件

根目录下创建 book.json

{
    "plugins": [
        "-lunr",
        "-search",
        "search-pro",
        "-sharing",
        "chapter-fold",
        "splitter",
        "collapsible-menu",
        "tbfed-pagefooter",
        "popup",
        "hide-element"
    ],
    "links": {
        "sidebar": {}
    },
    "language": "zh-hans",
    "title": "标题",
    "author": "作者",
    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright": "Copyright &copy 公司名",
            "modify_label": "文档修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        },
        "hide-element":{
            "elements": [".gitbook-link"]
        }
    }
}

3.2、安装插件

gitbook install

注：插件也可以用 npm 单独安装

3.3、再次生成 Html

gitbook build

　　

生成 PDF

生成 pdf 的方式有多种，百度最常见的是 gitbook 自带的命令，其他可以参考 新版gitbook导出pdf

1、下载 calibre

直接到官网下载： https://download.calibre-ebook.com/

安装后将安装地址配置到环境变量

ps：最好下载 3.x 的，5.x版本试了有问题

2、配置文件

根目录下创建/修改 book.json

{
    "language": "zh-hans",
    "title": "标题",
    "author": "作者",
    "pdf": {
        "pageNumbers": true,
        "fontFamily": "Arial",
        "fontSize": 20,
        "pagerSize": "a4",
        "margin": {
            "right": 56,
            "left": 56,
            "top": 45,
            "bottom": 45
        }
    }
}

3、生成 PDF

gitbook pdf

　　

参考来源

农药啊 的 Gitbook的使用教程

Broken故城 的 Gitbook教程（小白入坑gitbook全过程）

flydean程序那些事 的 新版gitbook导出pdf

姬小野 的 gitbook踩坑指南-无法转pdf、epub等；pdf调字体大小