react.dev README

The project's README from github.com/reactjs/react.dev. As one markdown file: README.md.

react.dev

This repo contains the source code and documentation powering react.dev.

Getting started

Prerequisites

  1. Git
  2. Node: any version starting with v16.8.0 or greater
  3. Yarn: See Yarn website for installation instructions
  4. A fork of the repo (for any contributions)
  5. A clone of the react.dev repo on your local machine

Installation

  1. cd react.dev to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the development server (powered by Next.js)
  2. open http://localhost:3000 to open the site in your favorite browser

Contributing

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections.

Create a branch

  1. git checkout main from any folder in your local react.dev repository
  2. git pull origin main to ensure you have the latest main code
  3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

  1. Follow the "Running locally" instructions
  2. Save the files and check in the browser
  3. Changes to React components in src will hot-reload
  4. Changes to markdown files in content will hot-reload
  5. If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

  1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
  2. Run yarn check-all. (This will run Prettier, ESLint and validate types.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix header logo on Android) to stage and commit your changes
  2. git push my-fork-name the-name-of-my-branch
  3. Go to the react.dev repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.

Translation

If you are interested in translating react.dev, please see the current translation efforts here.

License

Content submitted to react.dev is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.

react.dev (reactjs/react.dev)

Searching Database…

11.8K ·GitHub
React.dev
这是什么？这个仓库存放的是 react.dev 的源代码和内容。react.dev 是 React 库的官方文档网站，使用 Next.js 构建。
这是 React 库本身，还是只是它的文档？这里只是文档网站，包括讲解如何使用 React 的 Markdown 内容和 Next.js 前端。React 库的源代码位于另一个独立的仓库中。
我怎样在本地运行文档网站？克隆仓库，在 react.dev 文件夹内运行 'yarn' 安装依赖，然后运行 'yarn dev' 启动基于 Next.js 的开发服务器，再在浏览器中打开即可。
构建之前，我需要先安装什么？Git、Node.js v16.8.0 或更高版本，以及 Yarn 包管理器。
我修改内容后，能立刻看到变化吗？修改 src 中的 React 组件和 content 中的 Markdown 文件会自动热重载；但如果修改的是插件，可能需要删除 .cache 文件夹并重启开发服务器。
这个仓库是给谁用的？它面向想要修复或改进 React 文档的贡献者，而不是只想在项目中使用 React 的人。
我能帮忙把文档翻译成其他语言吗？可以。react.dev 目前有一个持续进行的社区翻译项目，贡献者可以参与，它与主要的英文内容是分开的。
是什么让 react.dev 上的代码示例可以交互？网站嵌入了 Sandpack（通过 @codesandbox/sandpack-react），可以直接在文档页面中渲染可实时编辑的 React 代码示例。
What are similar projects?content, 30-Days-Of-JavaScript, cheatsheets, react-redux-links, opensource.guide, youmightnotneedjquery, awesome-angular, zh-google-styleguide
Which topics is it in?website, translation, nextjs, reference, css, guide, documentation, html, learning, markdown, react, education
Creator
reactjs
Size
193 MB
Stars
11.8K
Updated
CommitOct 06
Age
9y
Commits · 90 Days