This repo contains the source code and documentation powering [ht.reactjs.org] which is the Haitian Creole translation of reactjs.org.
- 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
cd ht.reactjs.orgto go into the project root
yarnto install the website's npm dependencies
yarn devto start the hot-reloading development server (powered by Gatsby)
open http://localhost:8000to open the site in your favorite browser
You've cloned the repo, created your branch, and are armed with your favorite beverage to power you through a coding sprint, now what. The following diagram, highlights the primary files and directories you will modify in order to successfully translate documentation that gets rendered on the site.
. ├── CODE_OF_CONDUCT.md ├── GLOSSARY.md ├── README.md ├── content │ ├── home/ │ ├── docs/ │ ├── blog/ │ ├── tutorial/ │ ├── 404.md │ ... ├── src │ ├── pages/ │ ...
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 local
git pull origin masterto ensure you have the latest main code
git checkout -b the-name-of-my-branch(replacing
the-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
- Changes to markdown files in
- 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.
yarn check-allfrom the project root. (This will run Prettier, ESLint, and Flow.)
git add -A && git commit -m "My message"(replacing
My messagewith a commit message, such as
Fix header logo on Android) to stage and commit your changes
git 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.
yarn resetto clear the local cache
🚧👷🏼👷🏿 👷♀️ 🚧 ❌Home Page ❌Tutorial ❌Hello World ❌Introducing JSX ❌Rendering Elements ❌Components and Props ❌State and Lifecycle ❌Handling Events ❌Conditional Rendering ❌Lists and Keys ❌Forms ❌Lifting State Up ❌Composition vs Inheritance ❌Thinking in React ❌React ❌React.Component ❌ReactDOM ❌ReactDOMServer ❌DOM Elements ❌SyntheticEvent ❌Test Utilities ❌Shallow Renderer ❌Test Renderer ❌JS Environment Requirements ❌Glossary ❌tutorial/nav.yml ❌docs/nav.yml