uz.reactjs.org
uz.reactjs.org copied to clipboard
(Work in progress) React documentation website in Uzbek
uz.reactjs.org
React Uzbek Documentation
This repo contains the source code and documentation powering uz.reactjs.org.
Getting started
Prerequisites
- Git
- Node: any 12.x version starting with v12.0.0 or greater
- Yarn v1: See Yarn website for installation instructions
- A fork of the repo (for any contributions)
- A clone of the uz.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 mainfrom any folder in your localuz.reactjs.orgrepositorygit pull origin mainto 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 asFix header logo on Android) to stage and commit your changesgit push my-fork-name the-name-of-my-branch- Go to the uz.reactjs.org repo and you should see recently pushed branches.
- Follow GitHub's instructions.
- If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.
Translation
If you are interested in translating reactjs.org, please see the current translation efforts at translations.reactjs.org.
If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.
Troubleshooting
yarn resetto clear the local cache
License
Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.