Gitbook使用入门

安装Node

GitBook 基于 Node.js ，先装个 Node.js。

检测是否安装成功：

$ node -v
v10.12.0

Gitbook 安装

$ npm install -g gitbook-cli

检测安装是否成功：(第一次执行较慢，可以打开吃鸡跳一把伞)

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

开始吧

建个目录

$ mkdir gitbook
$ cd gitbook

初始化

$ gitbook init
warn: no summary file in this book 
info: create README.md 
info: create SUMMARY.md 
info: initialization is finished

这时自动创建了 README.md 和 SUMMARY.md 这两个文件。 README.md 就是说明文档，之后可以做你书的简介。SUMMARY.md放的是书的章节目录，就是等会页面看见左边那一竖条目录。

楞着干啥？起服务啊

$ gitbook serve

127.0.0.1：4000预览下吧

默认4000端口，不愿意用可以换

gitbook serve --port=4001

运行该命令后会在项目根目录生成一个 _book 文件夹, 里面的内容即为生成的 html 文件。是根据咱外面目录建的书籍md文件，生成一份目录层级想同的html文件。

可以使用下面命令只生成网页而不开启服务。

gitbook build

看是能看见了，可咋加内容，咋加目录啊？先看看书籍项目结构吧。

目录结构

先照着这个建一下目录

├── book.json
├── README.md
├── SUMMARY.md
├── 项目技术文档
|   ├── README.md
|   └── 接入文档
|       ├── 登录接入文档.md
|       └── 支付接入文档.md
└── _book（这个目录不要动，因为起服务的时候会自动清理）
    ├── 项目技术文档（起服务会自己生成，里面的md文件都变成html格式了）
    └── 这里有很多东西

先来抄几段代码吧

book.json

{
    "title":"一本好书",
    "description":"这真是一本好书啊！",
    "author":"peng",
    "output.name":"site",
    "language":"zh-hans",
    "gitbook":"3.2.3",
    "links":{
        "sidebar":{
            "来看看我":"https://blog.csdn.net/Lucis_Caelum"
        }
    },
    "plugins":[
        "-lunr",
        "-search",
        "-livereload",
        "search-plus@^0.0.11",
        "advanced-emoji@^0.2.1",
        "anchors@^0.7.1",
        "splitter@^0.0.8",
        "tbfed-pagefooter@^0.0.1",
        "expandable-chapters-small@^0.1.7",
        "sectionx@^3.1.0",
        "local-video@^1.0.1",
        "favicon@^0.0.2"
    ],
    "pluginsConfig":{
        "theme-default":{
            "showLevel":true
        },
        "sharing":{
            "weibo":true,
            "facebook":true,
            "twitter":true,
            "google":false,
            "instapaper":false,
            "vk":false,
            "all":[
                "facebook",
                "google",
                "twitter",
                "weibo",
                "instapaper"
            ]
        },
        "tbfed-pagefooter":{
            "copyright":"Copyright © peng.com 2018",
            "modify_label":"该文件修订时间：",
            "modify_format":"YYYY-MM-DD HH:mm:ss"
        },
        "sectionx":{
            "tag":"b"
        },
        "favicon":{
            "shortcut":"favicon.ico",
            "bookmark":"favicon.ico"
        }
    }
}

SUMMARY.md

# Summary

## 前言

* [介绍](README.md)

## 项目技术文档
* [接入文档](/项目技术文档/README.md)
  * [登录接入文档](/项目技术文档/接入文档/登录接入文档.md)
  * [支付接入文档](/项目技术文档/接入文档/支付接入文档.md)

README.md

# 项目技术文档

## 接入文档

* [接入文档](/项目技术文档/README.md)
* [登录接入文档](/项目技术文档/接入文档/登录接入文档.md)
* [支付接入文档](/项目技术文档/接入文档/支付接入文档.md)

代码抄完了，我们起服务

记得book.json中有个plugins么？我们需要先安装一波插件。

gitbook install

装完了吗？装完起服务了

gitbook serve

127.0.0.1:4000预览一波，看到效果了吗？这样就把内容和目录添加进去了。快去在 各种文档.md 里面添加一些内容吧！