PUBLISHING

本文档说明如何将这份文档发布到 GitBook。

方法一：通过 GitHub 集成（推荐）

1

创建 GitHub 仓库

# 初始化 Git 仓库
git init
git add .
git commit -m "Initial commit: Claude Code 源码分析文档"

# 添加远程仓库
git remote add origin https://github.com/your-username/claude-code-docs.git
git push -u origin main

2

连接到 GitBook

1. 访问 GitBook

2. 登录或注册账号

3. 点击 "New Space"

4. 选择 "Import from GitHub"

5. 选择你的仓库

6. 选择 docs 目录作为文档根目录

7. 点击 "Import"

3

配置同步

GitBook 会自动同步 GitHub 仓库的更新：

• 推送到 GitHub → 自动更新 GitBook

• 在 GitBook 编辑 → 自动提交到 GitHub

方法二：使用 GitBook CLI

1

安装 GitBook CLI

npm install -g gitbook-cli

2

初始化 GitBook

cd docs
gitbook init

3

本地预览

gitbook serve
# 访问 http://localhost:4000

4

构建静态网站

gitbook build
# 输出到 _book/ 目录

5

部署

将 _book/ 目录部署到：

• GitHub Pages

• Netlify

• Vercel

• 自己的服务器

方法三：直接上传

1

导出为 PDF

gitbook pdf ./ ./claude-code-docs.pdf

2

在 GitBook 中创建 Space

1. 访问 GitBook

2. 创建新 Space

3. 手动上传 Markdown 文件

文档结构验证

检查 SUMMARY.md

确保所有链接都正确：

# 检查所有链接的文件是否存在
grep -o '\[.*\](.*.md)' SUMMARY.md | \
  sed 's/.*(\(.*\))/\1/' | \
  while read file; do
    if [ ! -f "$file" ]; then
      echo "Missing: $file"
    fi
  done

检查内部链接

确保文档内的链接都有效：

# 查找所有 Markdown 链接
grep -r '\[.*\](.*.md)' . --include="*.md"

自定义配置

book.json (可选)

{
  "title": "Claude Code 源码分析",
  "description": "深入剖析 Claude Code 的技术实现",
  "author": "Your Name",
  "language": "zh-hans",
  "gitbook": "3.2.3",
  "structure": {
    "readme": "README.md",
    "summary": "SUMMARY.md"
  },
  "plugins": [
    "github",
    "search-pro",
    "code",
    "splitter"
  ],
  "pluginsConfig": {
    "github": {
      "url": "https://github.com/your-username/claude-code-docs"
    }
  }
}

持续更新

自动化工作流

创建 GitHub Actions 自动发布：

# .github/workflows/gitbook.yml
name: Publish to GitBook

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Trigger GitBook sync
        run: |
          curl -X POST https://api.gitbook.com/v1/spaces/$SPACE_ID/sync \
            -H "Authorization: Bearer $GITBOOK_TOKEN"

下一步

1. 初始化 Git 仓库

2. 推送到 GitHub

3. 连接到 GitBook

4. 开始分享你的文档

相关链接

• GitBook 文档

• GitHub Pages

• Markdown 语法