mirror of
https://github.com/reactjs/react.dev.git
synced 2026-02-26 07:25:20 +00:00
53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code when working with this repository.
|
|
|
|
## Project Overview
|
|
|
|
This is the React documentation website (react.dev), built with Next.js 15.1.11 and React 19. Documentation is written in MDX format.
|
|
|
|
## Development Commands
|
|
|
|
```bash
|
|
yarn build # Production build
|
|
yarn lint # Run ESLint
|
|
yarn lint:fix # Auto-fix lint issues
|
|
yarn tsc # TypeScript type checking
|
|
yarn check-all # Run prettier, lint:fix, tsc, and rss together
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
src/
|
|
├── content/ # Documentation content (MDX files)
|
|
│ ├── learn/ # Tutorial/learning content
|
|
│ ├── reference/ # API reference docs
|
|
│ ├── blog/ # Blog posts
|
|
│ └── community/ # Community pages
|
|
├── components/ # React components
|
|
├── pages/ # Next.js pages
|
|
├── hooks/ # Custom React hooks
|
|
├── utils/ # Utility functions
|
|
└── styles/ # CSS/Tailwind styles
|
|
```
|
|
|
|
## Code Conventions
|
|
|
|
### TypeScript/React
|
|
- Functional components only
|
|
- Tailwind CSS for styling
|
|
|
|
### Documentation Style
|
|
|
|
When editing files in `src/content/`, the appropriate skill will be auto-suggested:
|
|
- `src/content/learn/` - Learn page structure and tone
|
|
- `src/content/reference/` - Reference page structure and tone
|
|
|
|
For MDX components (DeepDive, Pitfall, Note, etc.), invoke `/docs-components`.
|
|
For Sandpack code examples, invoke `/docs-sandpack`.
|
|
|
|
See `.claude/docs/react-docs-patterns.md` for comprehensive style guidelines.
|
|
|
|
Prettier is used for formatting (config in `.prettierrc`).
|