React 中文文档

此仓库包含 React 中文文档 的文档及源码，并与官方保持实时同步。

参与贡献

目前，大部分翻译工作已完成。当前的主要任务是同步和完善已有翻译。

参与贡献前，请仔细阅读 Wiki，并遵循相关指南。

主要关注以下内容：

• React 中文文档译文规范
• 词汇表

翻译问题可直接提交 Pull Request 修改，其他问题请在 issue 中提出讨论。

---

react.dev

此仓库包含 react.dev 的源码和文档。

快速开始

环境要求

1. Git
2. Node：v16.8.0 或更高版本
3. Yarn：安装说明请参考 Yarn 官网
4. 本仓库的 fork（用于任何贡献）
5. 本地计算机上 react.dev 仓库 的克隆

安装

1. cd react.dev 进入项目根目录
2. yarn 安装网站的 npm 依赖

本地运行

1. yarn dev 启动开发服务器（基于 Next.js）
2. open http://localhost:3000 在你常用的浏览器中打开站点

参与贡献

指南

文档分为多个部分，每个部分有不同的风格和目的。如果你计划编写超过几句话的内容，建议先熟悉相应部分的贡献指南。

创建分支

1. 在本地 react.dev 仓库的任意目录下执行 git checkout main
2. 执行 git pull origin main 确保你拥有最新的 main 分支代码
3. 执行 git checkout -b the-name-of-my-branch 创建分支（将 the-name-of-my-branch 替换为合适的名称）

进行修改

1. 按照 “本地运行” 的说明操作
2. 保存文件并在浏览器中查看
3. src 中 React 组件的更改会热重载
4. content 中 Markdown 文件的更改会热重载
5. 如果使用插件，可能需要删除 .cache 目录并重启服务器

测试修改

1. 如果可能，请在常用浏览器的最新版本中测试所有视觉变化，涵盖桌面端和移动端。
2. 运行 yarn check-all。（这将运行 Prettier、ESLint 并校验类型。）

推送更改

1. 执行 git add -A && git commit -m "My message" 暂存并提交你的更改（将 My message 替换为提交信息，例如 Fix header logo on Android）
2. 执行 git push my-fork-name the-name-of-my-branch
3. 前往 react.dev 仓库，你应该能看到最近推送的分支。
4. 按照 GitHub 的说明操作。
5. 如果可能，请附上视觉更改的截图。你的更改推送到 GitHub 后会触发预览构建。

翻译

如果你有兴趣翻译 react.dev，请参阅当前的翻译工作。

许可证

提交到 react.dev 的内容采用 CC-BY-4.0 许可证，如 LICENSE-DOCS.md 文件所述。