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)

website
Searching Database…

11.8K ·GitHub
React.dev
What is this?This repository holds the source code and content for react.dev, the official documentation website for the React library, built with Next.js.
Is this the React library itself or just its docs?It's just the documentation website — the markdown content and Next.js frontend that explain how to use React. The actual React library source lives in a separate repository.
How do I run the docs site locally?Clone the repo, run 'yarn' inside the react.dev folder to install dependencies, then 'yarn dev' to start the Next.js-powered dev server and open it in your browser.
What do I need installed before I can build this?Git, Node.js v16.8.0 or newer, and the Yarn package manager.
Will my content edits show up instantly while I work on them?Changes to React components in src and markdown files in content hot-reload automatically, but if you're touching plugins you may need to delete the .cache folder and restart the dev server.
Who is this repo meant for?It's aimed at contributors who want to fix or improve the React documentation, not at people just looking to use React in a project.
Can I help translate the docs into another language?Yes, there is an ongoing community translation effort for react.dev that contributors can join, separate from the main English content.
What makes the code examples on react.dev interactive?The site embeds Sandpack (via @codesandbox/sandpack-react), which renders live, editable React code examples directly inside the documentation pages.
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