Gitbook 使用笔记

安装

1. 首先需要安装Node.js，安装教程见Windows 下 Node.js 的安装（多图版）
   
2. 确认Node.js安装好之后，使用如下命令安装gitbook；

npm install -g gitbook-cli

常用命令

命令 功能

gitbook init 初始化目录文件

gitbook help 列出gitbook所有命令

gitbook --help 列出gitbook-cli的帮助信息

gitbook build 生成静态网页

gitbook build --gitbook={version} 生成时指定gitbook版本

gitbook build --log=debug 指定log级别

gitbook build --debug 输出错误信息

gitbook serve 生成静态网页并允许服务器

gitbook ls 列出本地所有gitbook版本

gitbook ls-remote 列出远程可用的gitbook版本

gitbook fetch {tag/version} 安装对应gitbook版本

gitbook update 更新到最新版本

gitbook uninstall {version} 卸载对应版本gitbook

目录结构

一开始图书文件夹下为空，我们使用命令行工具，就会自动创建README.md和SUMMARY.md；

gitbook init

1. 而上一步中文件夹下生成的两个文件是图书必须具备的两个文件，我们可以对其修改：
   

• README.md：对当前图书的简介，即该图书的大概摘要。
  

  # LeetCode题集
  - 目的: 整理自己在LeetCode的解题思路；
  - 使用语言: `Java`

SUMMARY.md：即本书的目录结构；

  # Summary
  - [Introduction](README.md)
  - [Array](Array/README.md)
      - [LeetCode 1\. 两数之和](Array/LeetCode 1\. 两数之和.md)
  - [String](String/README.md)
      - [LeetCode 58.最后一个单词的长度](String/LeetCode 58.最后一个单词的长度.md)

创建并修改 README.md 和 SUMMARY.md 之后，再次使用命令行工具就会按SUMMARY.md给定的目录结构生成相应目录及文件；

gitbook init

此时生成的目录及文件树如下：

.
│  README.md
│  SUMMARY.md
│  
├─Array
│      LeetCode 1\. 两数之和.md
│      LeetCode 1.两数之和.md
│      README.md
│      
└─String
        LeetCode 58.最后一个单词的长度.md
        README.md

相关配置

常用的一些配置信息如下：

字段 功能

title 书本标题

author 书本作者

description 书本描述

language 使用的语言

gitbook 指定gitbook版本

root 指定存放gitbook文件的根目录

links 左侧导航栏添加链接信息

styles 自定义页面样式

plugins 配置使用的插件

pluginsConfig 配置插件属性

structure 指定Readme、Summary、Glossary、Languages对应文件名

structure对应变量名及默认值

变量 含义及默认值

structure.readme README.md

structure.summary SUMMARY.md

structure.glossary GLOSSARY.md

structure.languages LANGS.md

输出图书

目前 GitBook 支持生成如下格式的图书：

PDF

eBook

JSON

单个 HTML

静态 HTML（可当做静态网站）

静态 HTML 生成

当对图书文档编辑好之后，可用如下命令在本地进行预览，默认会启动本地的4000端口；

gitbook serve ./{book_name}

在浏览器中访问 http://localhost:4000/ 即可访问如下页面；

• 使用如下命令行工具，即可将内容输出到指定目录；
  

   gitbook build --output={path}
  ```
  ![image](https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy85NzQ3MzUwLTM3MDY4N2RkNjJhMTdjZTUucG5n?x-oss-process=image/format,png)
  生成的文件如下图所示，此时就可以将这些静态`HTML`打包部署到服务器或者发送给读者：
  ![image](https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy85NzQ3MzUwLTZkYjkzNjRmYjc5MTQ2MjAucG5n?x-oss-process=image/format,png)

生成mobi

切换到要生成的图书文件夹下，使用如下命令行工具即可生成mobi格式文件；

gitbook mobi

生成pdf

• 切换至要生成的图书文件夹下，使用如下命令行工具即可生成pdf格式文件；

gitbook pdf

注意： 转换时可能会出现如下错误，此需要安装calibre，然后重启命令行重新执行此命令即可；

EbookError: Error during ebook generation: 'ebook-convert' is not recognized as an internal or external command operable program or batch file

1

常见 PDF 导出参数

变量 描述

pdf.pageNumbers 是否添加页码，默认true

pdf.fontSize 字体大小，默认12

pdf.fontFamily 字体，默认Arial

pdf.paperSize 页面大小，有'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter'供选择，默认 a4

pdf.margin.top 上边距，默认56

pdf.margin.bottom 下边距，默认56

pdf.margin.right 右边距，默认62

pdf.margin.left 左边距，默认62

生成epub

切换至要生成的图书文件夹下，使用如下命令行工具即可生成epub格式文件；

gitbook epub