reactjs.org
This repo contains the source code and documentation powering reactjs.org.
Getting started
Prerequisites
- Git
- Node: any 8.x version starting with 8.4.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
Installation
cd reactjs.org
to go into the project rootyarn
to install the website's npm dependencies
Running locally
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 localreactjs.org
repositorygit pull origin master
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
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"
(replacingMy message
with a commit message, such asFixed 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 Netlify build will also be automatically created once you make your PR so other people can see your change.
Translation
If you are interesting in translating reactjs.org
to pt-BR, check the translation progress and claim a section/page to translate here. Also, when translating any content, make sure you follow this guide.
Troubleshooting
yarn reset
to clear the local cache
License
Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.