文章目录
-
- 环境准备
-
- Node.js 安装
- GitBook CLI 安装
- 项目初始化
-
- 创建项目结构
- (可选) npm 初始化
- 目录结构配置
- 开发与调试
-
- 本地服务启动
- 构建静态文件
- 配置文件详解
- 插件系统
-
- 常用插件推荐
- 插件安装与配置
- 自定义样式
- 部署指南
-
- GitHub Pages 部署
- Netlify 部署
- 高级功能
-
- 多语言支持
- 电子书导出
- 故障排除
-
- 常见问题解决
- GitBook 替代方案
- 结语
环境准备
Node.js 安装
由于 GitBook 已停止更新,建议使用 Node.js v10.x 版本以避免兼容性问题:
# 使用 nvm 安装和管理 Node.js 版本
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 10.22.0
nvm use 10.22.0
GitBook CLI 安装
npm install -g gitbook-cli
gitbook -V # 验证安装
项目初始化
创建项目结构
# 创建项目目录
mkdir my-documentation && cd my-documentation# 初始化 GitBook
gitbook init
初始化后会生成两个核心文件:
README.md
- 书籍简介SUMMARY.md
- 目录结构定义
(可选) npm 初始化
npm init -y
在 package.json
中添加脚本:
{"scripts": {"serve": "gitbook serve","build": "gitbook build","install": "gitbook install"}
}
目录结构配置
编辑 SUMMARY.md
文件来定义你的书籍结构:
# 目录概览* [简介](README.md)
* [第一部分: 基础概念](part1/README.md)* [1.1 写作指南](part1/writing.md)* [1.2 GitBook 功能](part1/gitbook.md)
* [第二部分: 高级功能](part2/README.md)* [2.1 反馈机制](part2/feedback_please.md)* [2.2 工具集成](part2/better_tools.md)
* [附录](appendix/README.md)
确保创建相应的目录和 Markdown 文件。
开发与调试
本地服务启动
# 直接使用 GitBook 命令
gitbook serve# 或使用 npm 脚本
npm run serve