reactjs/react.dev

★ 11,749JavaScriptAudience · developerComplexity · 2/5LicenseSetup · easy

Mindmap

mindmap
  root((react.dev))
    What it does
      React docs site
      Guides and tutorials
      API reference
    Tech stack
      Next.js
      Yarn
      MDX
    Use cases
      Fix docs errors
      Add code examples
    Audience
      React contributors
      Community translators

mindmap root((react.dev)) What it does React docs site Guides and tutorials API reference Tech stack Next.js Yarn MDX Use cases Fix docs errors Add code examples Audience React contributors Community translators

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Run the React docs site locally to preview your edits before submitting a pull request

USE CASE 2

Fix a typo, clarify an explanation, or add a code example to the official React documentation

USE CASE 3

Start or continue a community translation of the React docs into another language

USE CASE 4

Contribute a new guide or reference page by following the site's content format and tone guidelines

Tech stack

JavaScriptNext.jsYarn

Getting it running

Difficulty · easy Time to first run · 5min

Written content is licensed under CC-BY-4.0, meaning you can freely share and adapt it as long as you give credit.

In plain English

This repository holds the source code for react.dev, the official documentation website for the React JavaScript library. React is one of the most widely used tools for building web user interfaces, and this site is where its creators publish guides, references, and tutorials. The site itself is built with Next.js and managed with Yarn, two common JavaScript development tools. To run it on your own machine, you install the dependencies and start a local development server with a couple of commands. Changes to the site's content or components show up in the browser immediately without needing to restart anything. The repository is set up for community contributions. The guidelines explain that different sections of the documentation have different tones, so contributors are encouraged to read them before writing more than a sentence or two. Standard practice is to fork the repo, create a branch, make the edit, run the automated checks (which cover formatting, linting, and type validation), and open a pull request with screenshots if the change is visual. Translation of the site into other languages is an ongoing community effort, with a tracked issue listing the current status of each language. The written content on react.dev is licensed under CC-BY-4.0, meaning it can be freely shared and adapted with credit.

Copy-paste prompts

Prompt 1

I cloned react.dev and want to fix a typo in the Hooks reference page. Walk me through the full flow: install dependencies, start the local server, make the edit, run the automated checks, and open a PR.

Prompt 2

Show me how to add a new interactive code example to a react.dev tutorial page, including the MDX component format used in this repo.

Prompt 3

I want to start a community translation of react.dev into a new language. What files do I need to create first and where do I find the tracking issue?

Prompt 4

Run the linting, formatting, and type-checking steps for react.dev and explain what each check is validating and how to fix a failure.

Prompt 5

What is the difference in tone between the Learn section and the Reference section of react.dev, and how should I match that tone when writing a new page?

Open on GitHub → Explain another repo

← reactjs on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.