This repo contains the React documentation with typescript code. Exactly same format and structure as reactjs.org
- Git
- Node: install version 8.4 or greater (There are known issues with Node 10)
- Yarn: See Yarn website for installation instructions
- A fork of the repo (for any contributions)
- A clone of the react-docs-typescript repo on your local machine
cd react-docs-typescript
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 http://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 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
- 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 asFixed header logo on Android
) to stage and commit your changesgit push my-fork-name the-name-of-my-branch
- Go to the react-docs-typescript 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.
yarn reset
to clear the local cache
If you get an error related with gatsby during installation, follow these steps:
- Open Power Shell as admin
- Execute
npm install --global --production windows-build-tools
- Wait until it finishes and retry
yarn
"Error while loading shared libraries: libpng12.so.0: cannot open shared object file: No such file or directory"
Solution: install the libpng12-0 package.
Follow these steps (Debian):
dpkg -i libpng12-0_1.2.50-2+deb8u3_amd64.deb
Follow these steps (Ubuntu):
wget http://security.ubuntu.com/ubuntu/pool/main/libp/libpng/libpng12-0_1.2.54-1ubuntu1.1_amd64.deb
sudo dpkg -i libpng12-0_1.2.54-1ubuntu1.1_amd64.deb