学习gitbook发布自己的电子书

关于 Gitbook

来自官网的介绍

GitBook is a modern publishing toolchain. Making both writing and collaboration easy.

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

GitBook支持输出多种文档格式:

  • 静态站点:GitBook默认输出该种格式,生成的静态站点可直接托管搭载Github Pages服务上;
  • PDF:需要安装gitbook-pdf依赖;
  • eBook:需要安装ebook-convert;
  • 单HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程;
  • JSON:一般用于电子书的调试或元数据提取。

Gitbook 的效果展示

微信小程序使用手册 https://wechats.github.io/tinyapp-doc/

Gitbook 的用法

  1. 首先安装 nodejs 和 npm

  2. 全局安装GitBook

$ npm install gitbook-cli -g
  1. 创建一本书

$ gitbook init [目录名]

这时会在对应目录下生成 README.md 和 SUMMARY.md。 README.md 即为书的简介,会作为书的第一页显示。 SUMMARY.md 是书的目录,是 Gitbook 生成电子书的文件索引。

  1. 手动添加 book.json (可选)

{
    "plugins": [
        "betterchinese",
        "-duoshuo",
        "highlight",
        "lunr",
        "baidu_gio",
        "search",
        "fontsettings",
        "theme-default",
        "toolbar",
        "sharing"
    ],
    "pluginsConfig": {
        "lunr": {
            "maxIndexSize": 1000000,
            "ignoreSpecialCharacters": false
        },
        "baidu_gio": {
            "token": "Your Token"
        },
        "toolbar": {
            "buttons":
            [
                {
                    "label": "GitHub",
                    "icon": "fa fa-github",
                    "url": "https://github.com/wechats/tinyapp-doc"
                },
                {
                    "label": "PDF",
                    "icon": "fa fa-file-pdf-o",
                    "url": "https://wechats.github.io/tinyapp-doc/gen/tinyapp-doc.pdf"
                }
            ]
        },
        "sharing": {
            "facebook": false,
            "twitter": false,
            "google": false,
            "weibo": true,
            "instapaper": false,
            "vk": false,
            "all": ["weibo"]
        }
    }
}

book.json 是 Gitbook 的配置文件,plugins 元素定义 Gitbook 需要哪些插件,开头有‘-’代表禁用某个插件,pluginsConfig 定义某个插件的配置。 Gitbook 默认包含的插件分别是:

* highlight
* search
* lunr
* sharing
* fontsettings
* theme-default

如果想安装新插件,只需要先查询到插件名,然后写到 plugins 里面,再执行

$ gitbook install

Gitbook 会自动安装并使用新插件。

  1. Gitbook 的测试

当编辑完 Gitbook,我们可以通过以下命令进行测试:

$ gitbook serve

然后访问 http://localhost:4000 就能看到书的效果

  1. Gitbook 静态网站的生成

通过以下命令,可以输出 Gitbook 静态网站到 _book 文件夹

$ gitbook build
  1. 打包 PDF 等电子书的命令

$ gitbook pdf
$ gitbook mobi
$ gitbook epub
  1. 最后,将 _book 上传到自己的静态网页托管服务器就Over了!

PS: Gitbook 的相关资源地址

Gitbook 官网: https://www.gitbook.com

Gitbook Github: https://github.com/GitbookIO/gitbook

Gitbook Editor: https://www.gitbook.com/editor

Gitbook 插件页:http://plugins.gitbook.com

Gitbook 官方手册:http://toolchain.gitbook.com/

玩得愉快!

原文请戳: http://www.tonglei.win/2016/10/18/IT学习/Gitbook/学习gitbook发布自己的电子书/ @铜镭

转载于:https://my.oschina.net/tonglei0429/blog/760055

你可能感兴趣的:(json,git,javascript,ViewUI)