xyzblog

玩转gitbook

这是一款编写文档的神器。可以写电子书。还可以撰写接口文档。良心之作
 2016/2/25
Ubuntu git linux nodejs

GitBook 是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 来制作精美的电子书，GitBook 并非关于 Git 的教程。【百度百科】

首先Gitbook和Git/Github都没有什么关系。它只是一个build book的工具而已。但它的Git前缀的确引起了许多人的迷惑，起初我认为至少它也是个和Github类似的Git平台吧，但其实没什么关系，你只要懂几条markdown语法，不必理解任何与Git相关的东西就能用Gitbook了，不要为其名字迷惑。

安装GitBook

GitBook是Node.js的命令行工具,所以我们必须要安装node。 node官网下载

通过npm包管理工具安装Gitbook

sudo npm install -g itbook-cli

查看是否安装（显示Gitbook版本）

gitbook -V

使用GitBook

创建GitBook图书源码目录 并进入

mkdir gitbook

cd gitbook

创建图书简介文章文件

touch README.md

创建图书目录结构文件

touch SUMMARY.md

为文章撰写目录语法格式如下

vi SUMMARY.md

1
2
3
4
5
6
7
8
9

* [简介](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

此时会生成一个_book这个目录，而这个目录中的文件，即是生成的静态的html文件

在浏览器中预览 输入下面的命令 会监听4000端口开启一个服务器 【浏览器访问：（http://localhost:4000 ） 】

gitbook serve .

为图书添加版本控制

git init

为git仓库连接一个远程仓库 （github仓库或自己服务器的git仓库）

git remote add origin ssh://git@servername.com:/git/gitname.git

对书籍相关的配置 新建book.json

vi book.json

【 关于book.json各个参数的介绍 [请点击此](http://help.gitbook.com/format/configuration.html)】

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

{
    "title": "yangfch3's Diary",
    "author": "_",
    "description": "_",
    "extension": null,
    "generator": "website", // 使用的编译模式
    "isbn": null,
    "links": {
        "sharing": {
            "all": null,
            "facebook": null,
            "google": null,
            "twitter": null,
            "weibo": null
        },
        "sidebar": {
            "yangfch3's github": "http://github.com/yangfch3"
        }
    },
    "output": null, // 自定义指定编译输出目的文件夹
    "pdf": {
        "fontSize": 12,
        "footerTemplate": null,
        "headerTemplate": null,
        "margin": {
            "bottom": 36,
            "left": 62,
            "right": 62,
            "top": 36
        },
        "pageNumbers": false,
        "paperSize": "a4"
    },
    "mobi": {
        "fontSize": 12,
        "footerTemplate": null,
        "headerTemplate": null,
        "margin": {
            "bottom": 36,
            "left": 62,
            "right": 62,
            "top": 36
        },
        "pageNumbers": false,
        "paperSize": "a4"
    },
    "styles": {
        "website": "styles/website.css",
        "ebook": "styles/ebook.css",
        "pdf": "styles/pdf.css",
        "mobi": "styles/mobi.css",
        "epub": "styles/epub.css"
    },  // 用户自定义的样式，编译时对应的
    "plugins": ["disqus","codeblock-filename"],
    "pluginsConfig": {
        "disqus": {
            "shortName": "hub7diary"
        }
    },
    "variables": {}
}

当然你也可以使用gitbook 的客户端工具去开发 绝对是事半工倍 下载地址

  • 创建markdown文件

  • 把该文件的目录编写在 SUMMARY.md 的文件中

  • 撰写文章

    gitbook init  

git add .

git commit -m "文章更新"

git push origin master

  • 文章发布完成

就是这么简单。我决定了我要写本书。O(∩_∩)O哈哈~