项目简介
gbook 是基于 Go 语言开发的工具,主要用于解决 GitBook 3.2.3 版本插件下载缓慢的问题。由于该版本插件下载需整体拉取且不支持单个拉取,速度极慢,gbook 通过本地缓存和快速下载策略,实现了插件的快速下载。
项目的主要特性和功能
- 快速插件下载:借助本地缓存和自定义加速源,显著提升插件拉取速度。
- 无需频繁切换 Node 版本:设置
BOOK_NODE_HOME
环境变量后,可使用指定的 Node 版本执行命令,避免全局 Node 版本冲突。 - 易于使用:核心功能为
gbook install
,提供简洁的命令行接口。 - 支持 Docker 快速构建:可依据给定的配置文件,使用
docker compose
快速构建 gbook 文档。
安装使用步骤
前提条件
- 确保
node
版本 <= 10,建议使用 Node 版本 10.24.1。 - 安装
gitbook-cli
。 - 自行设置好 npm 加速镜像,如使用
nrm
设置淘宝镜像。
使用步骤
- 设置环境变量:将
BOOK_NODE_HOME
变量设置为所需的 node 版本路径,并加入系统变量。 - 运行命令:使用
gbook install
安装 GitBook 插件。 - Docker 快速构建:若使用 Docker,可使用以下配置文件:
```yml
version: "3.7"
services:
gbook-doc:
image: q9090960bnb3/gbook
ports:
- "4000:4000" volumes:
- .:/doc working_dir: /doc command: bash -c "gbook install && gbook serve" ```
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】