gitbook使用教程

发表于 | 更新于: | 分类于 | | 阅读次数:
字数统计: 940 | 阅读时长 ≈ 3

一、安装

gitbook依赖于node.js,安装也是通过nodejs的npm包管理器安装gitbook。你可以到node.js的官网下载。并添加nodejs的安装路径到环境变量path中。打开cmd或者其他终端（如git bash等），输入以下命令即可安装gitbook。

1
npm install gitbook-cli -g

二、使用

接下来讲一下gitbook工作区的概念。这个工作区就是你管理和编写book的地方。gitbook允许你在不同的目录上创建多个工作区。它们互不影响。现在就讲讲如何创建这样的工作区。首先，你需要先创建一个目录，如在桌面上创建了一个名称为mybook的目录（文件夹），然后通过以下命令对这个目录进行初始化:

1
gitbook init

通过以上初始化后会mybook里生成两个文件，分别是README.md和SUMMARY.md。这两个文件就是你写book的文件。其中README.md是book的每页内容，而SUMMARY.md的作用则是生成book的目录。这些目录和README.md是一一对应的关系。

1
gitbook build
1
gitbook serve

三、安装插件和优化功能

在mybook目录下创建一个名为book.json的文件。将以下内容复制粘贴到此文件中：

当然以下的gitbook、title、description、author 、github 、wechat需要根据你的情况来做修改。

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
{
    "gitbook": "3.2.3",
    "title": "Qcmoke's Book",
    "description": "https://qcmoke.site/",
    "author": "qcmoke",
    "language": "zh-hans",
    "links": {
        "sidebar": {

        }
    },
     "plugins": ["github",
                 "donate",
                 "splitter",
                 "anchor-navigation-ex",
                 "-sharing",
                 "sharing-plus",
                 "-highlight",
                 "prism"
                 ],
     "pluginsConfig": {
       "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/qcmoke"
        },
        "donate": {
            "wechat": "https://www.qcmoke.site/images/wechatpay.png",
            "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
        },
        "prism": {
            "css": [
             "prismjs/themes/prism-tomorrow.css"
            ]
  }
    }

}

然后执行以下命令即可安装插件并优化功能。

1
gitbook install ./

四、部署到github

如果还没有配置ssh key，你要先给本机配置好ssh key。然后在github上创建一个仓库。如名称为mygitbook的仓库。

你需要将gitbook工作下的_book初始化为git仓库。然后再推送到github远程仓库。大概如下：

1
2
3
4
5
6
7
$ gitbook build
$ cd _book
$ git init
$ git add
$ git commit -m "first commit"
$ git remote add origin git@github.com:qcmoke/mygitbook.git
$ git push -u origin master

以上部署完成后需要到github选择mygitbook仓库后，点击setting开启并设置github pages服务。具体如下：

  1. 将source设置为master或者gh-pages，并保存。此时便可以通过http://yourname.github.io/mygitbook（如果你再设置此仓库的pages前有在其他仓库设置过自定义域名，那么会通过http://你的域名）访问你的gitbook主页了。如果你需要通过https访问，你可以点击下方的Enforce HTTPS即可通过https进行访问。

  2. 此条为可选项<-----如果你需要再此仓库里另外设置域名，无论你之前是否有在其他仓库设置过自定义域名，在此仓库你还可以再设置自定义域名，可以是顶级域名，也可以是二级子域名，但不能和其他仓库的自定义域名一样，否则会冲突。前提是需要你到域名解析平台将该自定义域名解析一条CNAME记录到yourname.github.io 。并且可选性的添加Enforce HTTPS，自定义域名添加httts比较尴尬，需要你再等待24个小时左右才能成功。如果运气好的话会提前一些。

    1539793760124



----------- 本文结束 -----------




如果你觉得我的文章对你有帮助，你可以打赏我哦~
0%