文章目錄
-
- 環境準備
-
- 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