gitbook的安装与使用

gitbook的安装与使用

一、安装gitbook

1.1、基础条件

查看是否安装了nodejs

# node -v
v10.22.0
# npm -v
6.14.6

1.2、安装gitbook

使用npm安装 gitbook

# sudo npm install -g gitbook-cli

二、使用gitbook

2.1、创建书籍

在指定的目录中，通过gitbook官方模板创建书籍

# cd  /opt/blog
# 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 是目录页。

2.1.1、一般目录结构

├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1
├    ├── README.md
├    ├── something.md
├── chapter
├    ├── README.md
├    ├── something.md

文件名	描述
book.json	配置数据（可选）
README.md	电子书的前言或简介（必须）
SUMMARY.md	电子书目录 （可选）
GLOSSARY.md	词汇/注释术语列表（可选）

可以自己灵活制定自己的目录结构。

2.1.1、book.json的配置说明

变量	描述
root	包含所有图书文件的根文件夹的路径，除了 book.json
structure	指定自述文件，摘要，词汇表等的路径
title	您的书名，默认值是从 README 中提取出来的。在 GitBook.com 上，这个字段是预填的。
description	您的书籍的描述，默认值是从 README 中提取出来的。在 GitBook.com 上，这个字段是预填的。
author	作者名。在GitBook.com上，这个字段是预填的。
isbn	国际标准书号 ISBN
language	本书的语言类型 —— ISO code 。默认值是 en
direction	文本阅读顺序。可以是 rtl （从右向左）或 ltr （从左向右），默认值依赖于 language 的值。
gitbook	应该使用的GitBook版本，并接受类似于 >=3.0.0 的条件。
links	在左侧导航栏添加链接信息
plugins	要加载的插件列表(官网插件列表)
pluginsConfig	插件的配置

2.2、预览书籍

在gitbook书籍目录中执行如下命令，便可在本地通过访问http://localhost:4000 进行书籍预览

# gitbook serve

2.3、同时部署多个gitbook服务

gitbook启动的web 服务默认监听4000端口，而重启监控进程默认监听35729端口。
在不改变端口的前提下，一般只可以启动一个电子书web服务。

启动当前gitbook目录

gitbook serve 

启动/somepath/your_docuemtn_dir/下的gitbook目录

gitbook serve /somepath/your_docuemtn_dir/

启动完成后本地就可以通过 http://localhost:4000 进行访问。

如果需要启动多个web服务的话，需要同时修改web端口和监控进程端口：

gitbook serve --lrport 18081 --port 8081 /otherpath/your_docuemtn_dir/

2.4、生产电子书

• 需要有calibre-ebook环境 ➡ Linux下安装calibre-ebook
• GitBook生成pdf出现中文不显示或乱码

--- 生成PDF文件
# gitbook pdf ./ ./mybook.pdf
--- 生成ePub文件
# gitbook epub ./ ./mybook.epub
--- 生成Mobi文件
# gitbook mobi ./ ./mybook.mobi

三、插件

3.1、Gitbook 默认带有 5 个插件：

highlight - 语法高亮插件、search - 搜索插件、sharing - 分享插件、font-settings - 字体设置插件、livereload - 热加载插件

3.2、去除自带插件

可以在插件名称前面加 -

"plugins": [
  "-search"
]

Tips：添加插件后要进行安装 gitbook install

• 【吐血推荐】GitBook大神级中文参考文档
• GitBook插件整理 - book.json配置
• GitBook相关配置及优化
  GitBook相关使用以及配置笔记

gitbook常用CMD

gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令  
gitbook --help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
gitbook build --gitbook=2.0.1 //生成时指定gitbook的版本, 本地没有会先下载
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出远程可用的gitbook版本
gitbook fetch 标签/版本号 //安装对应的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //卸载对应的gitbook版本
gitbook build --log=debug //指定log的级别
gitbook builid --debug //输出错误信息

222	22
	22	222