本地安装 环境要求
安装 GitBook 是很简单的。您的系统只需要满足这两个要求:
NodeJS(推荐使用v4.0.0及以上版本)
Windows,Linux,Unix 或 Mac OS X
通过NPM安装
安装 GitBook 的最好办法是通过 NPM。只需运行以下命令即可安装 GitBook
npm install gitbook-cli -g
gitbook-cli 是 GitBook 的一个命令行工具。它将自动安装所需版本的 GitBook 来构建一本书。
执行下面的命令,查看 GitBook 版本,以验证安装成功。
gitbook -V
初始化GitBook
gitbook init
启动服务 - 使用下列命令会运行一个 web 服务, 通过 http://localhost:4000/ 可以预览书籍
gitbook serve
资料来源于:https://zhuanlan.zhihu.com/p/34946169
介绍一下gitbook中book.json的一些实用配置和插件
配置概况-全局配置
title 设置书本的标题
"title" : "Gitbook Use"
author 作者的相关信息
"author" : "mingyue"
description 本书的简单描述
"description" : "记录Gitbook的配置和一些插件的使用"
language
Gitbook使用的语言, 版本2.6.4中可选的语言如下:en, ar, bn, cs, de, en, es, fa, fi, fr, he, it, ja, ko, no, pl, pt, ro, ru, sv, uk, vi, zh-hans, zh-tw
例如,配置使用简体中文
"language" : "zh-hans"
links 在左侧导航栏添加链接信息
"links" : {
"sidebar" : {
"Home" : "https://www.baidu.com"
}
}
styles 自定义页面样式, 默认情况下各generator对应的css文件
"styles": {
"website": "styles/website.css",
"ebook": "styles/ebook.css",
"pdf": "styles/pdf.css",
"mobi": "styles/mobi.css",
"epub": "styles/epub.css"
}
例如使h1、h2标签有下边框, 可以在website.css中设置
h1 , h2{
border-bottom: 1px solid #EFEAEA;
}
1.2. 插件列表 plugins
配置使用的插件
"plugins": [
"-search",
"back-to-top-button",
"expandable-chapters-small",
"insert-logo"
]
其中"-search"中的 - 符号代表去除默认自带的插件
Gitbook默认自带有5个插件:
highlight: 代码高亮
search: 导航栏查询功能(不支持中文)
sharing:右上角分享功能
font-settings:字体设置(最上方的"A"符号)
livereload:为GitBook实时重新加载
1.3. 插件属性配置pluginsConfig
配置插件的属性
例如配置insert-logo的属性:
"pluginsConfig": {
"insert-logo": {
"url": "images/logo.png",
"style": "background: none; max-height: 30px; min-height: 30px"
}
}
资源参考与:https://www.jianshu.com/p/427b8bb066e6
GitBook - 插件安装 - 弹出查看大图
一个简单的 Gitbook 插件,在新窗口打开图片
{
"plugins": [
"popup"
]
}
安装插件
设置book.json配置文件如下:
{
"plugins": [
"-lunr", "-search", "search-pro",
"back-to-top-button",
"chapter-fold",
"code",
"splitter",
"tbfed-pagefooter",
"page-treeview",
"popup"
],
"pluginsConfig": {
"tbfed-pagefooter": {
"copyright": "Copyright © Aron.Li 2019",
"modify_label": "该文件修订时间:",
"modify_format": "YYYY-MM-DD HH:mm:ss"
},
"page-treeview": {
"copyright": "Copyright © aleen42",
"minHeaderCount": "2",
"minHeaderDeep": "2"
}
}
}
安装插件
gitbook install
点击图片后,就自动打开一个新的页面,展示图片。
资源参考与:https://blog.csdn.net/u012887259/article/details/102425726