知海

Claude Code 项目开发指南

React项目开发与贡献

Claude Code 项目开发指南

CLAUDE.md

本文件为 Claude Code 在使用此仓库时提供指导。

项目概览

这是 React 文档网站(react.dev),基于 Next.js 15.1.11 和 React 19 构建。文档采用 MDX 格式编写。

开发命令

bash 复制代码
yarn build         # 生产构建
yarn lint          # 运行 ESLint
yarn lint:fix      # 自动修复 lint 问题
yarn tsc           # TypeScript 类型检查
yarn check-all     # 依次运行 prettier、lint:fix、tsc 和 rss

项目结构

复制代码
src/
├── content/           # 文档内容(MDX 文件)
│   ├── learn/         # 教程/学习内容
│   ├── reference/     # API 参考文档
│   ├── blog/          # 博客文章
│   └── community/     # 社区页面
├── components/        # React 组件
├── pages/             # Next.js 页面
├── hooks/             # 自定义 React Hooks
├── utils/             # 工具函数
└── styles/            # CSS/Tailwind 样式

代码规范

TypeScript/React

  • 仅使用函数式组件
  • 使用 Tailwind CSS 进行样式设计

文档风格

编辑 src/content/ 中的文件时,相应的技能会被自动建议:

  • src/content/learn/ - 学习页面的结构和语气
  • src/content/reference/ - 参考页面的结构和语气

对于 MDX 组件(DeepDive、Pitfall、Note 等),请调用 /docs-components
对于 Sandpack 代码示例,请调用 /docs-sandpack

完整的风格指南请参阅 .claude/docs/react-docs-patterns.md

格式化使用 Prettier(配置在 .prettierrc 中)。

帮助我们改进文档

发现翻译问题或内容错误?请告诉我们。