GitBook 之旅

2019独角兽企业重金招聘Python工程师标准>>>

GitBook 之旅

为了方便管理，查阅.md文档，决定订册成书，使用 GitBook 生成静态网站，方便随意部署。

GitBook 已经非常出名，不再多复述，下面列出常用官方地址：

1. GitBook 官方 github 仓库地址
2. GitBook 官方文档地址
3. GitBook 官方插件地址

安装

安装其实很简单，不再复述，查阅官方文档内说明即可，并且不用担心因为版本的问题，出现的各种原因！

本文撰写版本为：3.2.3

基本目录结构

*默认必须要的文件。

.						// 根目录
├── book.json           // 配置文件，默认没有，需要新建
├── README.md           // * 对应书的前言说明
├── SUMMARY.md			// * 对应目录，用插件自动生成
├── chapter-1/          // 子级文件夹
|   ├── README.md       // 子级文件夹说明,如果没有该文件,子页面无介绍，不可点击
|   └── 1.md    		// 子页面
└── chapter-2/
    ├── README.md
    └── 1.md

基本命令

1. 安装完成，可以初始化一个模版，可以查看基本目录

   $ gitbook init
   

2. 编译，并启动http服务，可在浏览器内预览

   $ gitbook serve
   

3. 只进行编辑输出

   $ gitbook build
   

4. 安装插件

   $ gitbook install
   

配置文件

记录Gitbook的一些基本配置信息。

title-设置书本的标题

{"title" : "Gitbook Use"}

author-作者的相关信息

{"author" : "zhangjikai"}

description-本书的简单描述

{"description" : "本书的简单描述"}

language-使用的语言

{"language" : "zh-hans"}

root-指定存放 GitBook 文件（除了 book.json）的根目录

{"root": "."}

links-在左侧导航栏添加链接信息

{
    "links" : {
        "sidebar" : {
            "Home" : "http://xxx.com"
        }
	}
}

plugins-配置使用的插件

*设置完成后，记得执行安装命令

{
    "plugins": [
    	"fontsettings"
	]
}

pluginsConfig-配置插件的属性

*设置完成后，记得执行安装命令

{
    "pluginsConfig": {
        "fontsettings": {
            "theme": "sepia",
            "family": "serif",
            "size":  1
        }
    }
}

插件

丰富的插件才能构建出功能强大的GitBook。下面列表为实测可用插件。

summary 目录自动生成

{
    "plugins": [
        "summary"
	]
}

search-plus 搜索插件

支持中文!

{
    "plugins": [
        "-lunr",
        "-search",
        "search-plus"
	]
}

advanced-emoji ?表情支持

?

{
    "plugins": [
        "advanced-emoji"
	]
}

Splitter 使侧边栏的宽度可以自由调节

{
    "plugins": [
        "splitter"
    ]
}

Mermaid-gb3 支持渲染Mermaid图表

{
    "plugins": [
        "mermaid-gb3"
    ]
}

tbfed-pagefooter 页面添加页脚

{
    "plugins": [
       "tbfed-pagefooter"
    ],
    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy xx.com 2019",
            "modify_label": "该文件修订时间：",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        }
    }
}

copy-code-button 为代码块添加复制的按钮

{
    "plugins": ["copy-code-button"]
}

anchor-navigation-ex-toc 右侧页面导航条与回滚到顶部

{
    "plugins": ["anchor-navigation-ex-toc"]
}

转载于:https://my.oschina.net/u/3756690/blog/3022774