This repo contains the source code and documentation powering reactjs.org.
- Git
- Node: any 12.x version starting with v12.0.0 or greater
- Yarn: See Yarn website for installation instructions
- A fork of the repo (for any contributions)
- A clone of the reactjs.org repo on your local machine
cd reactjs.org
to go into the project rootyarn
to install the website's npm dependencies
yarn dev
to start the hot-reloading development server (powered by Gatsby)open https://localhost:8000
to 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 main
from any folder in your localreactjs.org
repositorygit pull origin main
to ensure you have the latest main codegit checkout -b the-name-of-my-branch
(replacingthe-name-of-my-branch
with a suitable name) to create a branch
- 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
- 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.)
git add -A && git commit -m "My message"
(replacingMy message
with a commit message, such asFix header logo on Android
) to stage and commit your changesgit 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 preview build is triggered after your changes are pushed to GitHub.
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 reset
to clear the local cache
Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.