人人都可快速上手的GitBook使用笔记（持续更新中）

介绍

GitBook是Markdown与HTML完美的结合。

百科介绍：GitBook是一个基于Node.js的命令行工具，可通过Markdown来制作电子书、在线文档等。
GitBook支持输出多种格式：

  1. PDF： 需要安装gitbook-pdf依赖；
  2. eBook： 需要安装ebook-convert；
  3. 单HTML网页： 支持将内容输出为单页的HTML。

前置条件

  • 需要安装Node.js；
  • 安装GitBook命令行工具；
  • MarkDown常用语法；

本文介绍环境配置

  • NPM版本： 5.6.0
  • OS版本：Windows10
  • CLI version: 2.3.2
  • GitBook version: 3.2.3

相关网站

使用步骤

GitBook的初始化，编译和预览等均需要在命令行进行，就像hexo编写个人博客一样。

安装GitBook工具

1
npm install gitbook-cli -g

初始化

新建一个目录，命令行打开该目录，然后以下输入命令，就可以初始化书籍，生成两个文件（没有生成其他教程说的book.json）：

  • README.md：书籍介绍
  • SUMMARY.md：书籍目录
1
gitbook init

编译成html

生成的文件在上述目录下的_book文件夹下

1
gitbook build

本地进行预览

浏览器中打开http://localhost:4000进行预览。

1
gitbook serve

相关命令

1
2
gitbook update # 更新gitbook

手动给GitBook添加book.json

因为使用gitbook init生成的目录默认是没有book.json的，那么要引入其他的插件的话就需要自己手动在根目录创建一个book.json，
配置之后需要使用gitbook install安装book.json中配置的插件。
基本格式如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
{
  "gitbook": "3.2.3",
  "title": "标题",
  "description": "文档描述",
  "author": "作者",
  "language": "zh-hans",
  "links": {
    "gitbook": true,
    "sharing": {
      "google": false,
      "facebook": false,
      "twitter": false,
      "all": false
    }
  },//分享按钮是否展示
  "plugins": [
    "github",
    "donate",
    "splitter",
    "anchor-navigation-ex",
    "-sharing",
    "sharing-plus",
    "-highlight",
    "prism",
    "disqus",
    "editlink",
    "baidu",
    "sitemap",
    "tbfed-pagefooter",
    "fontsettings",
    "simple-page-toc",
    "links"
  ],
  "pluginsConfig": {
    "tbfed-pagefooter": {
      "copyright": "",
      "modify_label": "文件修改时间：",
      "modify_format": "YYYY-MM-DD HH:mm:ss"
    },// 文件的修改时间，以及版权声明等
    "simple-page-toc": {
      "maxDepth": 3,
      "skipFirstH1": true
    },
    "sharing": {
      "douban": false,
      "facebook": false,
      "google": false,
      "hatenaBookmark": false,
      "instapaper": false,
      "line": false,
      "linkedin": false,
      "messenger": false,
      "pocket": false,
      "qq": false,
      "qzone": false,
      "stumbleupon": false,
      "twitter": false,
      "viber": false,
      "vk": false,
      "weibo": false,
      "whatsapp": false,
      "all": [
        "weibo",
        "qq",
        "qzone",
        "google",
        "douban"
      ]
    },
    "github": {
      "url": "https://github.com/nelucifer"
    },
    "donate": {
      "wechat": "",
      "title": "",
      "button": "赏",
      "wechatText": "微信打赏"
    },
    "anchor-navigation-ex": {
      "associatedWithSummary": false,
      "showLevel": true,
      "multipleH1": true,
      "mode": "float",
      "pageTop": {
        "showLevelIcon": false,
        "level1Icon": "fa fa-hand-o-right",
        "level2Icon": "fa fa-hand-o-right",
        "level3Icon": "fa fa-hand-o-right"
      }
    },
    "theme-default": {
      "showLevel": true
    },
    "fontsettings": {
      "theme": "white",
      "family": "serif",
      "size": 2
    },// 显示样式以及文字大小的主题
    "sidebar": {
    },
    "disqus": {
      "shortName": "webpack-handbook" //生成评论
    },
    "github": {
      "url": "https://github.com/nelucifer/front-template"
    },
    "editlink": {
      "base": "https://github.com/nelucifer/",
      "label": "编辑本页面" //内容顶部显示 编辑本页 链接，点击跳转到配置的源码存放位置
    },
    "baidu": {
      "token": "" //百度站长工具统计
    },
    "sitemap": {
      "hostname": "http://baidu.com/"//站点地图
    },
    "prism": {
      "css": [
        "prismjs/themes/prism-tomorrow.css"
      ]
    }
  }
}