The React documentation website
Xizario and alexkrolick Add Kendo suite to the Fee Based Components list (#1128)
* Add Kendo suite to the Fee Based Components list

* Update tools-ui-components.md
Latest commit 34118dc Oct 19, 2018
Permalink
Failed to load latest commit information.
.circleci no cache fallback Jul 11, 2018
.github Update PULL_REQUEST_TEMPLATE.md Mar 9, 2018
content Add Kendo suite to the Fee Based Components list (#1128) Oct 19, 2018
examples HTTPS-ify lots of URLs, update some to their newer homes (#1157) Oct 5, 2018
flow-typed Upgrade to Gatsby v2 (#1104) Sep 19, 2018
gatsby fix: prevent gatsby file detection from breaking path field (#1226) Oct 3, 2018
plugins HTTPS-ify lots of URLs, update some to their newer homes (#1157) Oct 5, 2018
src Feature headings easier to read Oct 17, 2018
static HTTPS-ify lots of URLs, update some to their newer homes (#1157) Oct 5, 2018
.babelrc Upgrade to Gatsby v2 (#1104) Sep 19, 2018
.eslintignore Updated .eslintignore Nov 7, 2017
.eslintrc Added fbjs eslint config, fixed lint errors and warnings Oct 9, 2017
.flowconfig Added some basic Flow types to get things started Oct 5, 2017
.gitignore Bumped docs version Sep 6, 2018
.nvmrc point at 8.x.x release branch instead of exact 8.4 Jul 11, 2018
.prettierrc Moved Prettier config to config file Oct 5, 2017
CODE_OF_CONDUCT.md Added COC Oct 16, 2018
CONTRIBUTING.md Update CONTRIBUTING.md (#1234) Oct 7, 2018
LICENSE-DOCS.md Moved the CC license file to cover docs only Oct 7, 2017
README.md Tweaked licensing wording in README slightly Oct 16, 2018
crowdin.yaml Updates CrowdIn configuration to use /lang/folder/file.md Nov 17, 2017
gatsby-browser.js Upgrade to Gatsby v2 (#1104) Sep 19, 2018
gatsby-config.js chore: minor tweaks and run prettier Sep 28, 2018
gatsby-node.js Upgrade to Gatsby v2 (#1104) Sep 19, 2018
package.json chore: remove/update pinned gatsby-remark-prismjs plugin (#1253) Oct 12, 2018
yarn.lock chore: remove/update pinned gatsby-remark-prismjs plugin (#1253) Oct 12, 2018

README.md

reactjs.org

This repo contains the source code and documentation powering reactjs.org.

Getting started

Prerequisites

  1. Git
  2. Node: any 8.x version starting with 8.4.0 or greater
  3. Yarn: See Yarn website for installation instructions
  4. A fork of the repo (for any contributions)
  5. A clone of the reactjs.org repo on your local machine

Installation

  1. cd reactjs.org to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the hot-reloading development server (powered by Gatsby)
  2. 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

  1. git checkout master from any folder in your local reactjs.org repository
  2. git pull origin master to ensure you have the latest main code
  3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

  1. Follow the "Running locally" instructions
  2. Save the files and check in the browser
  3. Changes to React components in src will hot-reload
  4. Changes to markdown files in content will hot-reload
  5. If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

  1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
  2. Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed header logo on Android) to stage and commit your changes
  2. git push my-fork-name the-name-of-my-branch
  3. Go to the reactjs.org repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. 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 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.