The React documentation website
This repo contains the source code and documentation powering reactjs.org.
cd reactjs.orgto go into the project root
yarnto install the website's npm dependencies
yarn devto start the hot-reloading development server (powered by Gatsby)
open http://localhost:8000to open the site in your favorite browser
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.
git checkout mainfrom any folder in your local
git pull origin mainto ensure you have the latest main code
git checkout -b the-name-of-my-branch(replacing
the-name-of-my-branchwith a suitable name) to create a branch
.cachedirectory and restart the server
yarn check-allfrom the project root. (This will run Prettier, ESLint, and Flow.)
git add -A && git commit -m "My message"(replacing
My messagewith a commit message, such as
Fix header logo on Android) to stage and commit your changes
git push my-fork-name the-name-of-my-branch
If you are interested in translating
reactjs.org, please see the current translation efforts at translations.reactjs.org.
If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.
yarn resetto clear the local cache