gitbook 介绍

gitbook网站是一个简单的个人在线书籍网站，在这里可以把自己的文档整理成书籍发布出来，便于阅读。
gitbook网站：https://legacy.gitbook.com/

可以使用gitbook工具，来制作精美的电子书,然后部署到自己的网站上(或在github托管)。

本文主要介绍gitbook工具

基本操作

1
2
3
4
5
6
7
8
9
10
11
# Install
npm install -g gitbook-cli

# init
gitbook init

# serve
gitbook serve

# build
gitbook build

部署

通过docker部署一个nginx

1
2
3
4
5
6
7
8
9
web:
  image: nginx:1.20
  privileged: true
  volumes:
   - ./conf.d:/etc/nginx/conf.d
   - ./www/_book:/data/www/_book
   - /data/logs/nginx:/data/logs/nginx
  ports:
   - "80:80"

将gitbook中文档，build为H5页面，上传到服务器，即可访问

1
2
3
4
5
6
7
8
9
10
11
# localhost
gitbook build
zip -qr _book.zip _book

# linux
cd /data/services/nginx/www
sudo rz -bey
unzip _book.zip

# restart nginx
docker-compose up -d

插件

Gitbook默认自带有5个插件：

highlight： 代码高亮
search： 导航栏查询功能（不支持中文）
sharing：右上角分享功能
font-settings：字体设置（最上方的”A”符号）
livereload：为GitBook实时重新加载

新建一个book.json文件

1
2
3
4
5
6
7
8
{
    "plugins": [
        "-lunr",
        "expandable-chapters",
        "html5-video",
        "search-pro"
    ]
}
  • 视频插件html5-video
  • 菜单折叠 expandable-chapters
  • 中文搜索search-pro
  • 添加-为禁用插件

gitbook install来安装插件

参考文档

gitbook常用的插件