GitBook的使用

gitbook介绍

GitBook 是一个基于 Node.js 的命令行工具，支持 Markdown 和 AsciiDoc 两种语法格式，可以输出 HTML、PDF、eBook 等格式的电子书。

GitBook 是使用 GitHub / Git 和 Markdown（或AsciiDoc）构建漂亮书籍的命令行工具（和Node.js库）；

GitBook.com 是使用 GitBook 格式创建和托管图书的在线平台。它提供托管，协作功能和易于使用的编辑器。

gitbook的优势

gitbook的使用倾向于文档开发，或者个人笔记文档类的存储，便于阅读和查找。gitbook支持markdown以及git，可以实现相关内容的编写，也能实现代码托管。
gitbook + markdown + git的优势：

• 语法简单
• 兼容性强
• 导出方便
• 专注内容
• 团队协作

gitbook安装步骤

1. 安装node.js
   因为 GitBook 是基于 Node.js，所以我们首先需要安装 Node.js（下载地址：https://nodejs.org/en/download/），找到对应平台的版本安装即可。
2. Gitbook是使用NPM来进行安装的，可以在命令行中输入下面的命令进行安装：

$ npm install gitbook-cli -g

3. 检查安装

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

编辑书籍

1. 初始化一本书

gitbook init

在使用 gitbook init 之后本地会生成两个文件 README.md 和 SUMMARY.md 。

• README.md —— 书籍的介绍
• SUMMARY.md —— 书籍的目录结构

2. 编辑电子书
   GitBook使用SUMMARY.md文件组织整个内容的目录，在 SUMMARY.md 文件中添加目录。

# Summary

## 基本使用
* [Introduction](README.md)
* [前言](introduction.md)
* [安装](installation.md)
* [命令](commands.md)
* [目录结构](structure.md)
* [配置](settings.md)
    * [Google Dapper](dapper.md)

## 扩展
* [插件](plugins.md)
* [主题](themes.md)
* [bookjson](bookjson.md)

3. 查看构建的书籍
   到这一步，书籍已经建立好了，可以直接运行命令本地预览查看。

gitbook serve

安装插件

gitbook的相关页面配置都是依赖于相关插件，并对插件进行配置。
在book.json文件下配置插件后，执行命令统一安装。

$ gitbook install

{
    "title": "GitBook 基本使用",
    "description": "GitBook 的配置和一些插件的使用",
    "author": "Gloria",
    "output.name": "site",
    "language": "zh-hans",
    "gitbook": "3.2.3",
    "root": ".",
    "structure": {
        "readme": "introduction.md"
    },
    "links": {
        "sidebar": {
            "Home": "http://www.Gloria.com"
        }
    },
    "plugins": [
        "-lunr",
        "-search",
        "-highlight",
        ....
        ],
        "pluginsConfig": {
	        "theme-default": {
	            "showLevel": true
	        },
	        "insert-logo": {
	            "url": "assets/images/logo.png",
	            "style": "background: none; max-height: 30px; min-height: 30px"
	        },
	        ...
	   }
 }

gitbook的插件很多，此处不一一列举，详情查看文档。
gitbook常用插件
如果常用插件不能满足需求，可以在npm官网，搜索gitbook查看相关插件配置。

发布电子书

当电子书内容制作好之后，可以使用如下命令来生成 HTML 静态网页版电子书。该命令会在当前文件夹中生成 _book 文件夹，这个文件夹中的内容就是静态网页版电子书。

使用 --log=debug --debug 可以用来调试，会打印出 stack trace。

gitbook build
gitbook build ./{book_name} --output=./{outputFolde}
gitbook build ./ --log=debug --debug

开发工具

使用gitbook编辑电子书，可以使用Typora 。

• Typora 下载地址：https://typora.io/
  Typora支持markdown文档的编辑，可以更直观的编辑文档。
  

github

https://github.com/zouzouxinxian/gitbook-use