mirror of
https://github.com/reactjs/react.dev.git
synced 2026-02-25 13:13:08 +00:00
941c1a4efc
- you can _just_ open it in - It _renders_ a heading saying “Hello, world!” on the page. - you are using the same word as the thing you are describing. - “A Note on JavaScript” the title doe snot suggest that you need to read it because you are learning about react ,not JS. Something like “React & JavaScript” or something like “Knowledge Level Assumptions” - “we recommend **refreshing** your JavaScript knowledge so you can follow along more easily.” — refreshing suggest that someone. Already knows JS, so if they don’t know JS they will feel dejected. Try “We highly recommend [going through a Javascript tutorial]() to check your knowledge level.” - “We also use some of the ES6 syntax” - **We** that suggests its a us vs the user. Instead go for “**The documentation** will use some [ES6 Syntax](LINK TO WHAT IS ES6)”
reactjs.org
This repo contains the source code and documentation powering reactjs.org.
Getting started
Prerequisites
- Git
- Node: install version 8.4 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.orgto go into the project rootyarnto install the website's npm dependencies
Running locally
yarn devto start the hot-reloading development server (powered by Gatsby)open http://localhost:8000to 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 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 branch
Make the change
- Follow the "Running locally" instructions
- Save the files and check in the browser
- Changes to React components in
srcwill hot-reload - Changes to markdown files in
contentwill hot-reload - If working with plugins, you may need to remove the
.cachedirectory 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-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 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, please join the Crowdin.
Troubleshooting
yarn resetto clear the local cache