GitBook相关使用以及配置笔记

本地安装

GitBook的安装非常简单。您的系统只需满足这两个要求：

  • NodeJS（推荐使用v4.0.0及以上版本）
  • Windows，Linux，Unix或Mac OS X

gitbook-cli 是安装和管理GitBook版本库的程序。它会自动安装GitBook所需的模块来创建一本书。

$ npm install gitbook-cli -g

gitbook使用常见指令：

$ gitbook init  // 在当前目录创建一本书
$ gitbook init ./directory  // 用现有的目录来创建一本书
$ gitbook serve // 预览创建的书
$ gitbook build // 构建静态网站
$ gitbook install // 初始化安装插件

目录结构

一般GitBook目录如下：

.
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md
  • book.json:配置文件数据
  • README.md:简介-书籍的简单介绍
  • SUMMARY.md:目录

以子目录的方式与项目集成

对于软件项目，可以使用子目录(如docs/)来存储项目的文档。您可以在book.json中通过配置选项告诉GitBook在那里找到根目录：

.
├── book.json
└── docs/
    ├── README.md
    └── SUMMARY.md

book.json配置如下：

{
    "root": "./docs"
}

菜单与页面

GitBook使用一个SUMMARY.md文件来定义文档的菜单。

SUMMARY.md中[]内的内容是标题，()内是文档的路径，章节和子章节用四个空格或者tab键来分级。

 菜单示例：

# 概述
### 服务介绍
* [服务介绍](README.md)

### 服务接入流程

* [服务开通](serviceOpen.md)
* [应用配置](appConfig.md)

### 企业实名认证服务端API
* [API服务规范](apiStandard.md)
* [营业执照OCR接口](apiOCR.md)

配置

GitBook允许您使用灵活的配置自定义书籍和文档。这些选项在book.json文件中指定。

常用的配置如下：

{
    "root": "./docs", 
    "language" : "zh-hans",
    "styles": {
        "website": "./styles/website.css"
    }, 
    "plugins": [
        "hide-element",
        "back-to-top-button",
        "chapter-fold",
        "code",
        "splitter",
        "custom-favicon",
        "insert-logo",
        "tbfed-pagefooter",
        "-sharing",
        "sharing-plus"
    ], 
    "pluginsConfig": {
        "hide-element": {
            "elements": [
                ".gitbook-link"
            ]
        },
        "insert-logo": {
            "url": "./images/logo.png",
            "style": "background: none; max-height: 60px; min-height: 50px"
        },
        "favicon": "./images/favicon.ico",
        "sharing": {
            "twitter": false,
            "facebook": false,
            "google": false
        },
        "tbfed-pagefooter": {
            "copyright":"北京科技XXX公司版权所有",
            "modify_label":"该文章修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }
}

也可以使用gitbook editor编辑markdown文件。

参考地址

 

posted @ 2020-01-03 17:37  风雨后见彩虹  阅读(1239)  评论(0)  编辑  收藏  举报