react.dev README

The project's README from github.com/reactjs/react.dev. As one markdown file: README.md.

react.dev

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

Getting started

Prerequisites

  1. Git
  2. Node: any version starting with v16.8.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 react.dev repo on your local machine

Installation

  1. cd 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 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.

react.dev (reactjs/react.dev)

Searching Database…

11.8K ·GitHub
React.dev
Что это такое?Этот репозиторий содержит исходный код и контент для react.dev, официального сайта документации библиотеки React, созданного на Next.js.
Это сама библиотека React или только её документация?Это только сайт документации: контент в формате markdown и фронтенд на Next.js, которые объясняют, как пользоваться React. Исходный код самой библиотеки React находится в отдельном репозитории.
Как запустить сайт документации локально?Склонируйте репозиторий, выполните 'yarn' внутри папки react.dev, чтобы установить зависимости, затем 'yarn dev', чтобы запустить локальный сервер разработки на базе Next.js, и откройте его в браузере.
Что нужно установить перед сборкой?Git, Node.js версии v16.8.0 или новее и менеджер пакетов Yarn.
Будут ли мои правки контента сразу видны во время работы?Изменения React-компонентов в папке src и markdown-файлов в папке content подхватываются автоматически, но если вы меняете плагины, может понадобиться удалить папку .cache и перезапустить сервер разработки.
Для кого предназначен этот репозиторий?Он рассчитан на участников, которые хотят исправить или улучшить документацию React, а не на тех, кто просто хочет использовать React в проекте.
Могу ли я помочь с переводом документации на другой язык?Да, для react.dev ведётся работа сообщества над переводом, к которой могут присоединиться участники. Она отделена от основного английского контента.
Что делает примеры кода на react.dev интерактивными?На сайт встроен Sandpack (через @codesandbox/sandpack-react), который выводит живые редактируемые примеры кода на React прямо на страницах документации.
What are similar projects?content, 30-Days-Of-JavaScript, cheatsheets, react-redux-links, opensource.guide, youmightnotneedjquery, awesome-angular, zh-google-styleguide
Which topics is it in?website, translation, nextjs, reference, css, guide, documentation, html, learning, markdown, react, education
Creator
reactjs
Size
193 MB
Stars
11.8K
Updated
CommitOct 06
Age
9y
Commits · 90 Days