mirror of
https://github.com/reactjs/react.dev.git
synced 2026-02-23 20:23:08 +00:00
7fafb9f916
* Break out Installation into top-level doc section * Update navigation (prev/next, nav tree) - Move Installation section to top - Add next/prev to install pages * add links to other install options from try react page * fix markdown link * Clarify that Quick Start and Install are optional "next steps" * Add top-level CDN page This is useful for Codepen and other Unpkg-y setups * Add link to Tutorial from Try React * Update CRA link in tutorial * Make Try React subheader a proper sentence * Add "minimal" * Explain local dev setup is more work than Codepen etc * Fix typos * Add : between headings * add note that CRA is not lightweight * fix typo * Update add-react-to-a-new-app.md * Update add-react-to-a-new-app.md * Remove the Bower note * Update try-react.md * Tweak wording * Use direct link
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 clone of the reactjs.org repo on your local machine
- A fork of the repo (for any contributions)
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
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.
Troubleshooting
yarn resetto clear the local cache