GitBook

一切皆往事
2,541 阅读4分钟

安装GitBook

安装GitBook之前，要确认本地已经安装好node.js

node.js下载地扯

如下图所示：

全局安装GitBook ：

npm install gitbook-cli -g

检验是否安装成功：

GitBook的初步使用

初始化一本书

gitbook init

生成如下文件：

解释：

  • README.md 说明文件。
  • SUMMARY.md 左侧菜单目录结构文件。

运行这本书

gitbook serve

如下图所示：

浏览器访问效果图如下所示：

构建静态网站

gitbook build

上面的命令执行后会在根目录生成一个文件夹_book,里面的文件如下：

配置文件book.json

该文件需要自行创建。如下结构：

{
    "title": "一切皆往事",
    "author": "往事",
    "description": "书中自有往事",
    "language": "zh-hans",
    "gitbook": "3.2.3",
    "plugins":[
    	"expandable-chapters-small",
    	"search-plus",
    	"sharing",
    	"splitter",
    	"anchor-navigation-ex-toc",
    	"hide-element"
    ]
}

相关信息解释：

  • title：标题信息。
  • author 作者信息。
  • description 书的描述。
  • language 设置展示的语言。
  • gitbook 这本书的版本。
  • plugins里是GitBook的插件。配置好之后，要先使用gitbook install进行插件的安装。然后再执行gitbook serve即可看到效果了。

gitbook install之后，会发现目录多出了一个文件夹名为node_modules 如下图所示：

常用插件

插件描述

注意：每次添加一次新的插件后，要进行安装gitbook install。

去除插件

可以在插件名称前面加 - 如下：

"plugins":[
    "-lunr",
    "-search"
]

隐藏导航菜单下方的链接

如下图所示：

使用hide-element插件。在book.json中加入：

{
    "title": "一切皆往事",
    "author": "往事",
    "description": "书中自有往事",
    "language": "zh-hans",
    "gitbook": "3.2.3",
    "plugins":[
    	"expandable-chapters-small",
    	"search-plus",
    	"sharing",
    	"splitter",
    	"anchor-navigation-ex-toc",
    	"hide-element",
    	"-lunr",
    	"-search"
    ],
    "pluginsConfig": {
    	"hide-element": {
    		"elements": [".gitbook-link"]
    	}
    }
}

pluginsConfig这个是主要的。

导航上方Logo

这个要使用到insert-logo插件。相关信息如下：

{
    "title": "一切皆往事",
    "author": "往事",
    "description": "书中自有往事",
    "language": "zh-hans",
    "gitbook": "3.2.3",
    "plugins":[
    	"expandable-chapters-small",
    	"search-plus",
    	"sharing",
    	"splitter",
    	"anchor-navigation-ex-toc",
    	"hide-element",
    	"-lunr",
    	"-search"
    ],
    "pluginsConfig": {
    	"hide-element": {
    		"elements": [".gitbook-link"]
    	},
        "insert-logo": {
        	"url": "images/logo.png"
            "style": "background:none;max-height:120px;min-height:120px;"
        }
    }
}

多级菜单编写

修改SUMMARY.md文件，内容如下：

* [说明文档](README.md)
* [第一章](Demo/demo1.md)
  - [1.1. 我来了](Demo/demo2.md)
    - [1.1.1 我又来了](Demo/demo2.md)

在SUMMARY.md同级目录下自行在创建Demo文件夹，里面再创建两个文件：demo1.md和demo2.md

执行命令gitbook serve后如下图所示：

avatar
文章
阅读
粉丝