Skip to content

CLAUDE.md

Latest commit

 

History

History
73 lines (54 loc) · 2.44 KB

CLAUDE.md

File metadata and controls

73 lines (54 loc) · 2.44 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

项目概述

这是一个用 Docusaurus 3 构建的中文技术文档网站，内容是《Claude Code 源码精读》系列教程，共 14 章 84 篇文章，深度解析 Claude Code AI Agent 的内部工程实现。

常用命令

使用 pnpm 作为包管理器：

pnpm start          # 启动本地开发服务器（热重载）
pnpm build          # 构建静态网站到 build/ 目录
pnpm serve          # 本地预览构建产物
pnpm typecheck      # TypeScript 类型检查
pnpm clear          # 清除 .docusaurus 缓存（构建异常时使用）

架构概览

技术栈

  • Docusaurus 3.9.2 + React 19 + TypeScript 5.6
  • MDX 3：文档中可嵌入 React 组件
  • i18n 配置为 zh-Hans（仅中文简体）

目录结构

  • docs/ — 文档内容（14 个章节目录，每章 4-11 篇 .md/.mdx 文件）
  • src/components/ — 7 个自定义 React 组件（每个含 .tsx + .module.css）
  • src/css/ — 全局样式：custom.css（主题变量）、themes.css（三套配色）
  • src/hooks/useProgress.ts — 学习进度 Hook，持久化到 localStorage
  • src/pages/index.tsx — 自定义首页（英雄区 + 章节卡片 + 进度条）
  • src/theme/ — Docusaurus 主题定制（文章页脚集成 Giscus 评论、导航栏项目）
  • docusaurus.config.ts — 网站核心配置（URL、导航、主题、插件）
  • sidebars.ts — 侧边栏配置（autogenerated 自动从 docs 目录生成）

自定义组件

组件 用途
ArticleComplete 文章学习完成标记按钮
ChapterProgress 章节完成进度徽章
DifficultyBadge 文章难度标签（入门/进阶/深度）
ProgressBar 全局学习进度条
SourceRef 源码参考链接
ThemeSwitcher 颜色主题切换（Default/Ink/Paper）

部署

  • GitHub Actions 自动部署到 GitHub Pages（main 分支推送触发）
  • 同时支持 Vercel 自动部署
  • 配置文件：.github/workflows/deploy-gh-pages.yml

新增文档的规范

每篇文章的 frontmatter 结构：

---
sidebar_position: 1
title: 文章标题
description: 文章描述
---

在文章中使用自定义组件需通过 MDX import：

import DifficultyBadge from '@site/src/components/DifficultyBadge';

<DifficultyBadge difficulty="进阶" />