The React documentation website

License: CC-BY-4.0

Language: JavaScript

Keywords: documentation, javascript, react, website

This repo contains the source code and documentation powering

Getting started


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


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

Running locally

  1. yarn dev to start the hot-reloading development server (powered by Gatsby)
  2. open http://localhost:8000 to open the site in your favorite browser


Create a branch

  1. git checkout master from any folder in your local repository
  2. git pull origin master 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 from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed 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 repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. If possible include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.


  • yarn reset to clear the local cache

Project Statistics

Sourcerank 10
Repository Size 77.2 MB
Stars 5,163
Forks 4,670
Watchers 155
Open issues 913
Dependencies 630
Contributors 466
Tags 0
Last updated
Last pushed

Top Contributors See all

Paul O’Shannessy Sophie Alpert Pete Hunt Dan Abramov Christopher Chedeau Cheng Lou Jim Brian Vaughn marocchino Kohei TAKATA Connor McSheffrey Daniel Lo Nigro iamchenxin Jinwoo Oh Timothy Yung Toru Kobayashi Yangshun Tay Jake Moxey Sebastian Markbåge Ivan Zotov

Interesting Forks See all

The React documentation website
JavaScript - Last pushed - 12 stars - 6 forks
The React documentation website
JavaScript - CC-BY-4.0 - Updated - 4 stars
The React documentation website
JavaScript - CC-BY-4.0 - Last pushed - 2 stars
The React documentation website
JavaScript - CC-BY-4.0 - Last pushed - 1 stars
The React documentation website
JavaScript - CC-BY-4.0 - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2017-10-12 07:09:05 UTC

Login to resync this repository