logo
0
0
WeChat Login
Vcentzhou<vcentzhou@cnb.cool>
✨ feat: 实现 Copy Page 智能抓取与三层监控体系

Claude Code 文档同步系统

一个自动化系统,用于实时跟踪 Claude Code 官方文档的更新情况,自动抓取英文文档,使用 OpenRouter.ai 的 gemini-2.5-flash-lite 模型翻译成中文,并自动推送到 Git 仓库。

项目结构

Claude doc/ ├── src/ # 源代码 │ ├── __init__.py │ ├── document_fetcher.py # 文档抓取模块 │ ├── translator.py # AI 翻译模块 │ ├── git_pusher.py # Git 推送模块 │ └── sync.py # 主控制脚本 │ ├── scripts/ # 脚本文件 │ └── run.sh # 启动脚本 │ ├── docs/ # 文档 │ ├── README.md # 本文件 │ ├── USAGE.md # 详细使用指南 │ ├── CLAUDE.md # Claude Code 配置 │ └── SECURITY.md # 安全策略 │ ├── config/ # 配置文件 │ ├── config.yaml # 主配置 │ ├── .env.example # 环境变量模板 │ └── requirements.txt # Python 依赖 │ ├── docs/ # 文档目录 │ ├── source/ # 英文原版文档 │ │ ├── overview.md # 概述 │ │ ├── quickstart.md # 快速开始 │ │ ├── sub-agents.md # 子代理 │ │ ├── hooks.md # 钩子 │ │ ├── mcp.md # MCP (Model Context Protocol) │ │ ├── plugins.md # 插件 │ │ ├── cli-reference.md # CLI 参考 │ │ ├── setup.md # 安装配置 │ │ ├── settings.md # 设置 │ │ ├── troubleshooting.md # 故障排除 │ │ └── ... # 其他47个文档 │ │ │ └── translated/ # 中文翻译版文档 │ ├── overview.md # 概述 │ ├── quickstart.md # 快速开始 │ ├── sub-agents.md # 子代理 │ ├── hooks.md # 钩子 │ ├── mcp.md # MCP │ ├── cli-reference.md # CLI 参考 │ ├── setup.md # 安装配置 │ ├── settings.md # 设置 │ ├── troubleshooting.md # 故障排除 │ └── ... # 其他47个文档 │ ├── .env # 环境变量(本地,不被 Git 跟踪) └── .gitignore # Git 忽略规则

系统特性

🔍 三层监控体系

  • 第一层:文档结构监控(新增、删除、重命名)
  • 第二层:文档内容监控(哈希变化检测)
  • 第三层:抓取翻译流程(只处理变化的文档)
  • 精确检测,只处理真正需要更新的文档
  • 缓存机制提高性能

📄 Copy Page 智能抓取

  • 优先使用 Copy Page 方式:提取最干净、最适合 LLM 处理的文档内容
  • 智能质量评估:自动评估内容质量,必要时降级到传统方式
  • 结构化内容保留:完整保留标题、代码块、列表、链接等重要元素
  • 干扰元素过滤:自动排除导航、广告、页脚等干扰内容
  • 标题去重机制:避免页面标题与内容标题重复

🤖 AI 驱动翻译

  • 使用 OpenRouter.ai 的 google/gemini-2.5-flash-lite 模型
  • 智能文本分块处理(支持大文档)
  • 保留代码块和 Markdown 格式
  • 自动重试机制和错误恢复

🔄 全自动化工作流

  • 监控 → 检测 → 抓取 → 翻译 → 提交 → 推送
  • 支持持续运行模式(定时检查)
  • 智能批量处理(并行度可配置)

🛠️ 灵活配置

  • YAML 配置文件
  • 环境变量管理敏感信息
  • 支持测试模式和强制更新

快速开始

1. 安装依赖

cd scripts ./run.sh install

2. 配置环境变量

# 复制环境变量模板 cp ../config/.env.example .env # 编辑 .env 文件,设置您的 API 密钥 vim .env

3. 运行系统

# 执行一次同步 ./run.sh sync # 持续运行模式(每小时检查一次) ./run.sh continuous # 查看系统状态 ./run.sh status

文档统计

  • 总计文档数量: 47个
  • 英文文档: 47个
  • 中文翻译: 47个(AI 驱动翻译)

主要文档类别

1. 入门指南 (Getting Started)

  • overview.md - Claude Code 概述
  • quickstart.md - 快速开始
  • common-workflows.md - 常见工作流

2. 核心功能 (Build with Claude Code)

  • sub-agents.md - 子代理
  • hooks.md - 钩子系统
  • mcp.md - Model Context Protocol
  • skills.md - 技能系统
  • memory.md - 内存管理
  • checkpointing.md - 检查点机制

3. 集成部署 (Deployment)

  • third-party-integrations.md - 第三方集成
  • github-actions.md - GitHub Actions
  • gitlab-ci-cd.md - GitLab CI/CD
  • slack.md - Slack 集成
  • amazon-bedrock.md - Amazon Bedrock
  • google-vertex-ai.md - Google Vertex AI
  • microsoft-foundry.md - Microsoft Foundry

4. 管理配置 (Administration)

  • setup.md - 安装配置
  • iam.md - 身份认证管理
  • security.md - 安全
  • costs.md - 成本管理
  • monitoring-usage.md - 使用监控
  • network-config.md - 网络配置

5. 设置参考 (Configuration)

  • settings.md - 设置
  • model-config.md - 模型配置
  • output-styles.md - 输出样式
  • terminal-config.md - 终端配置
  • interactive-mode.md - 交互模式
  • headless.md - 无头模式

6. 工具平台 (Reference)

  • cli-reference.md - CLI 参考
  • plugins.md - 插件系统
  • plugin-marketplaces.md - 插件市场
  • plugins-reference.md - 插件参考
  • slash-commands.md - 斜杠命令
  • statusline.md - 状态行

7. 桌面应用 (Desktop)

  • claude-code-on-the-web.md - 网页版
  • desktop.md - 桌面版
  • vs-code.md - Visual Studio Code
  • jetbrains.md - JetBrains IDE
  • devcontainer.md - 开发容器

8. 其他 (Resources)

  • legal-and-compliance.md - 法律合规
  • data-usage.md - 数据使用
  • analytics.md - 分析
  • llm-gateway.md - LLM 网关
  • sandboxing.md - 沙盒机制

核心模块

DocumentFetcher

负责抓取 Claude Code 官方文档。

主要功能:

  • 获取文档索引
  • 抓取文档内容
  • 检测文档更新(基于哈希)
  • 保存到本地

DocumentTranslator

负责翻译文档,使用 OpenRouter.ai API。

主要功能:

  • 文本分块处理
  • 保留代码块和格式
  • 重试机制
  • 异步翻译

GitPusher

负责 Git 操作和自动推送。

主要功能:

  • 检测文件变更
  • 自动提交
  • 推送到远程仓库
  • 分支管理

使用建议

  1. 首次运行:建议先使用 --test 模式测试
  2. 监控日志:定期检查 sync.log 文件
  3. 备份数据:定期备份翻译结果
  4. 网络稳定:确保网络连接稳定
  5. API 配额:监控 OpenRouter API 使用量

注意事项

  • 本文档集合仅供学习交流使用
  • 所有内容版权归 Anthropic 公司所有
  • 请遵守相关法律法规和使用条款
  • 建议访问官方文档获取最新信息:https://code.claude.com/docs

安全策略

本项目严格遵循安全最佳实践,确保敏感信息得到妥善保护。详细信息请参阅 SECURITY.md

抓取时间

2025年12月17日


注意: 这是一个自动化抓取和翻译的项目,翻译质量由 AI 模型保证。如需高质量的中文文档,建议等待官方中文版或进行人工专业翻译。

About

No description, topics, or website provided.
Language
Python96.7%
Shell3.3%