Giter Site home page Giter Site logo

reactjs / vi.reactjs.org Goto Github PK

View Code? Open in Web Editor NEW
84.0 12.0 100.0 149.15 MB

(Work in progress) React documentation website in Vietnamese

Home Page: https://vi.react.dev

License: Creative Commons Attribution 4.0 International

JavaScript 34.75% CSS 7.81% HTML 0.29% Shell 0.01% TypeScript 57.14%

vi.reactjs.org's Introduction

vi.react.dev

This repo contains the source code and documentation powering react.dev.

Getting started

Prerequisites

  1. Git
  2. Node: any 12.x version starting with v12.0.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 vi.react.dev repo on your local machine

Installation

  1. cd vi.react.dev to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the development server (powered by Next.js)
  2. open http://localhost:3000 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 main from any folder in your local react.dev repository
  2. git pull origin main 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. (This will run Prettier, ESLint and validate types.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix 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 vi.react.dev repo and you should see recently pushed branches.
  4. Follow GitHub's instructions.
  5. 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 react.dev, please see the current translation efforts here.

License

Content submitted to react.dev is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.

vi.reactjs.org's People

Contributors

acdlite avatar alexkrolick avatar bvaughn avatar chenglou avatar danglequocbao001 avatar danilowoz avatar dependabot[bot] avatar fozg avatar gaearon avatar jimfb avatar koba04 avatar kohei-takata avatar lex111 avatar ltmylinh avatar marocchino avatar mcsheffrey avatar petehunt avatar react-translations-bot avatar reactjs-translation-bot avatar rickhanlonii avatar robhrt7 avatar ryan-lt avatar sebmarkbage avatar sophiebits avatar tesseralis avatar tuantvk avatar vjeux avatar yangshun avatar zpao avatar zqran avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

vi.reactjs.org's Issues

Translate the glossary

React - Bảng chú giải dịch thuật dành cho Tiếng Việt

Dưới đây là bảng định nghĩa một số thuật ngữ trong React, những thuật ngữ quen thuộc sẽ vẫn giữ nguyên ở Tiếng Anh.

Thuật Ngữ Dịch
Tutorial Hướng dẫn
Application Ứng dụng
syntax cú pháp
Embedding Expressions Biểu Thức Nhúng
Attributes Thuộc Tính
Elements Những Element
Composition Kết hợp
Inheritance Kế Thừa
Handling Events Bắt Sự Kiện
Conditional Rendering Render Theo Điều Kiện
Operator Toán tử
Reuse tái sử dụng
Note Lưu ý

Không dịch Không dịch
Declarative Test Case
Component Test Runder
render Mock/Mocked
Stateful Component Fetch/Fetching
state Backend
mock Frontend
callback Route/Router
External Plugins Database
Third Plugins Life Cycle
Props Function
Ref Package
Data Import
Warning Accessibility
Functional Components Code-Splitting
Class Components Context
API endpoint Refs
Render Higher-Order Components
Bug/Bugs Portal
Issue Profiler
Static Type

Vietnamese Translation Progress

For New Translators

To translate a page:

  1. Check that no one else has claimed your page in the checklist and comments below.
  2. Comment below with the name of the page you would like to translate. Take only one page at a time.
  3. Clone this repo, translate your page, and submit a pull request!

Before contributing, read the glossary and style guide to understand how to translate various technical and React-specific terms.

You can use the Crowdin as a base for your translation. Make sure to compare the content with the current React website to makes sure everything is up to date! (NOTE: delete this if the language doesn't have any Crowdin contributions)

Please be prompt with your translations! If you find that you can't commit anymore, let the maintainers know so they can assign the page to someone else.

For maintainers

When someone volunteers, edit this issue with the username of the volunteer, and with the PR. Ex:

When PRs are merged, make sure to mark that page as completed!

Core Pages

To do before releasing as an "official" translation. Please translate these pages first.

Basics

API Reference

Navigation

These are the navigation links that appear in the sidebar. Possibly wait until
the corresponding sections are translated to do these.

Next Steps

These are the next most important translations, ordered by importance:

Installation

Hooks

Everyone is hooked on hooks! People are really excited about these and it would be great for them to be translated.

Testing

Warnings

These are the pages that you get when you click the links in the console (e.g. https://reactjs.org/warnings/dont-call-proptypes.html). People tend to search these, so please don't translate the error message itself.

Advanced Guides

FAQ

Contributing

Priority: Low

Components

Components in src/components that have some text in them.

  • CodeEditor
  • CodeExample
  • ErrorDecoder
  • LayoutFooter
  • LayoutHeader
  • MarkdownPage

Additional Translations

These are not the primary translation targets.

  • Blog
  • Community

New Vietnamese Translation Progress

Maintainers

For New Translators

To translate a page:

  1. Check that no one else has claimed your page in the checklist and comments below.
  2. Comment below with the name of the page you would like to translate. Take only one page at a time.
  3. Clone this repo, translate your page, and submit a pull request!

Before contributing, read the glossary and style guide to understand how to translate various technical and React-specific terms.

You can use the Crowdin as a base for your translation. Make sure to compare the content with the current React website to make sure everything is up to date! (NOTE: delete this if the language doesn't have any Crowdin contributions)

Please be prompt with your translations! If you find that you can't commit anymore, let the maintainers know so they can assign the page to someone else.

For maintainers

When someone volunteers, edit this issue with the username of the volunteer, and with the PR. Ex:

* [x] Some Page (@somebody) #12345

When PRs are merged, make sure to mark that page as completed!

Main Content

To do before releasing as an "official" translation. Please translate these pages first.

Note that each section has an index page, which needs to be translated too.

Learn React

  • Quick Start (@ltmylinh)

  • Installation (@ninh-nd) #347

  • Describing the UI

    • Your First Component (@ninh-nd) #354
    • Importing and Exporting Components
    • Writing Markup with JSX (@bboy114crew)
    • JavaScript in JSX with Curly Braces
    • Passing Props to a Component
    • Conditional Rendering (@kienngo98) #348
    • Rendering Lists
    • Keeping Components Pure
  • Adding Interactivity

    • Responding to Events (@phuc1nguyen) #359
    • State: A Component's Memory
    • Render and Commit (@hminh2027) #358
    • State as a Snapshot (@ThangHuuVu) #360
    • Queueing a Series of State Updates
    • Updating Objects in State
    • Updating Arrays in State
  • Managing State

    • Reacting to Input with State (@NghiaDangTran)
    • Choosing the State Structure
    • Sharing State Between Components
    • Preserving and Resetting State
    • Extracting State Logic into a Reducer
    • Passing Data Deeply with Context
    • Scaling Up with Reducer and Context
  • Escape Hatches

    • Referencing Values with Refs
    • Manipulating the DOM with Refs
    • Synchronizing with Effects
    • You Might Not Need an Effect
    • Lifecycle of Reactive Effects
    • Separating Events from Effects
    • Removing Effect Dependencies
    • Reusing Logic with Custom Hooks

API Reference

  • react: Hooks

    • useCallback (@Quynh-Nguyen)
    • useContext
    • useDebugValue (@viettrung9012) #364
    • useDeferredValue
    • useEffect
    • useId
    • useImperativeHandle
    • useInsertionEffect
    • useLayoutEffect
    • useMemo
    • useReducer
    • useRef
    • useState (@nguyentran-se)
    • useSyncExternalStore
    • useTransition
  • react: Components

  • react: APIs

    • createContext
    • forwardRef
    • lazy (@leduc1901) #361
    • memo
    • startTransition
  • react-dom: Components

    • Common (e.g. <div>)
    • <input>
    • <option>
    • <progress>
    • <select>
    • <textarea>
  • react-dom: APIs

    • createPortal
    • flushSync
    • findDOMNode
    • hydrate
    • render
    • unmountComponentAtNode
  • react-dom/client: Client APIs

    • createRoot
    • hydrateRoot
  • react-dom/server: Server APIs

    • renderToNodeStream
    • renderToPipeableStream
    • renderToReadableStream
    • renderToStaticMarkup
    • renderToStaticNodeStream
    • renderToString

Navigation and UI

We suggest to leave most of the UI translation until the end. We plan to do some invasive changes to the website folder layout and components, so postponing this until your translation is almost complete would make it easier to merge the changes from our side later. It might make sense to translate the homepage above the fold early, but leave the rest for later. As individual pages get translated, you can change the page titles in the corresponding sidebar files. Finally, when you're translating the navigation, make sure to test both desktop and mobile layouts.

  • Homepage (currently in HomeContent.js)
  • Sidebars (currently in src/sidebar*.json)
  • Top-level navigation (currently in TopNav.tsx)

When You're Ready...

After everything above is translated, add your language to deployedLanguages in Seo.tsx of the original reactjs/react.dev repository.

Secondary Content

These API pages should ideally be translated too, but they're less urgent and can be done after the others:

  • Legacy React APIs
    • Children
    • cloneElement
    • Component
    • createElement
    • createFactory
    • createRef
    • isValidElement
    • PureComponent

Optional Content

These aren't the main translation targets, but if you'd like to do them, feel free to expand the list to include their subpages:

  • Community
  • Blog
  • Warnings

Review process

This issue is created to discuss about review process:

  • How many approvals do we need for a PR?
  • Who will take responsibility to merge PR?

URL endpoints

Should we keep all the url endpoints the same or change them as we translate?

For example, the current endpoint for tutorial is /tutorial. Do we change it to something like /hướng-dẫn or just leave it as it is?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.