CLAUDE.md
Guides Claude Code with Docusaurus v3 build commands, multi-instance docs architecture, and deployment to GitHub Pages.
What this file does
Guides Claude Code with Docusaurus v3 build commands, multi-instance docs architecture, and deployment to GitHub Pages.
When to use it
- You maintain a Docusaurus v3 site with multiple doc plugin instances
- You want Claude Code to run build and deploy commands consistently
- You need Claude to understand your custom CSS and syntax highlighting setup
- You deploy to GitHub Pages via a CI workflow on main branch pushes
Assumes this stack
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
常用命令
yarn start # 启动本地开发服务器，地址为 http://localhost:3000
yarn build # 构建生产环境静态站点，输出到 /build/ 目录
yarn serve # 本地预览构建产物
yarn clear # 清除 Docusaurus 缓存（构建异常时使用）
yarn deploy # 部署到 GitHub Pages（通常由 CI 自动执行）
架构说明
本项目是基于 Docusaurus v3 的静态文档站点，部署在 GitHub Pages，域名为 yianzhou.com。
多实例文档结构
站点使用了多个 Docusaurus docs 插件实例，每个实例对应 /docs/ 下的一个顶级目录。每个实例在 docusaurus.config.js 中单独配置，并在 sidebars.js 中有对应的侧边栏定义。新增文档板块时，需要同时修改 docusaurus.config.js（添加插件实例）和 sidebars.js（添加侧边栏配置）。
内容
所有内容以 Markdown/MDX 格式存放在 /docs/ 目录下，侧边栏根据文件系统结构自动生成。原生支持 Mermaid 图表，并在 docusaurus.config.js 中为 Dart 和 Swift 配置了自定义语法高亮。
样式
自定义样式覆盖写在 /src/css/custom.css 中，通过 Infima CSS 变量控制亮色/暗色主题的色彩。
部署
向 main 分支推送代码会触发 .github/workflows/deploy.yml，自动构建并将产物推送到 gh-pages 分支。自定义域名通过 /static/CNAME 配置。
回答偏好
请称呼用户为安哥。
What's inside
5 command groups, 4 architecture sections, 1 answer preference
Change this for your project
- Replace
yianzhou.comwith your own custom domain - Replace
安哥with your preferred address for Claude - Replace
yianzhou/yianzhou.github.iowith your repository name in the deploy workflow reference
Where it goes
Save as CLAUDE.md in your repository root. Claude Code reads it automatically at the start of every session.
Related Documents
Code indexing for AI agents: summarization strategies and evaluation systems
Synthesises 2024-2025 research on code indexing for AI agents, covering summarisation strategies, hybrid retrieval architectures, and evaluation benchmarks.
write-script
Guides an AI through writing a YouTube video script with strict structural, language, and quiz rules for a survival channel.
Claude AI Git Workflow Integration
Recommends using the git-ai-commit CLI tool for AI-generated commit messages instead of manual ones.
Missing Business Agents Research — FLUXION 2026
Identifies 12 missing business operations agents for an indie software company and ranks them by impact and effort with €0 implementation plans.