yarn dev to start the hot-reloading development server (powered by Gatsby)
open http://localhost:8000 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
git checkout master from any folder in your local reactjs.org repository
git pull origin master to ensure you have the latest main code
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
Follow the "Running locally" instructions
Save the files and check in the browser
Changes to React components in src will hot-reload
Changes to markdown files in content will hot-reload
If working with plugins, you may need to remove the .cache directory and restart the server
Test the change
If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)
Push it
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
git push my-fork-name the-name-of-my-branch
Go to the reactjs.org repo and you should see recently pushed branches.
Follow GitHub's instructions.
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.
Translation
If you are interested in translating reactjs.org, please see the current translation efforts at isreacttranslatedyet.com.
If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.
ThugDebugger/reactjs.org
reactjs.org
This repo contains the source code and documentation powering reactjs.org.
Getting started
Prerequisites
Installation
cd reactjs.orgto go into the project rootyarnto install the website's npm dependenciesRunning locally
yarn devto start the hot-reloading development server (powered by Gatsby)open http://localhost:8000to open the site in your favorite browserContributing
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
git checkout masterfrom any folder in your localreactjs.orgrepositorygit pull origin masterto ensure you have the latest main codegit checkout -b the-name-of-my-branch(replacingthe-name-of-my-branchwith a suitable name) to create a branchMake the change
srcwill hot-reloadcontentwill hot-reload.cachedirectory and restart the serverTest the change
yarn check-allfrom the project root. (This will run Prettier, ESLint, and Flow.)Push it
git add -A && git commit -m "My message"(replacingMy messagewith a commit message, such asFix header logo on Android) to stage and commit your changesgit push my-fork-name the-name-of-my-branchTranslation
If you are interested in translating
reactjs.org, please see the current translation efforts at isreacttranslatedyet.com.If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.
Troubleshooting
yarn resetto clear the local cacheLicense
Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.