Добавлены инструкции по внесению изменений на русском

This commit is contained in:
Igor Brylyov 2021-05-17 15:57:24 +00:00
parent de8c9f80fd
commit 146aeec333

View file

@ -1,33 +1,75 @@
# Website
# Документация проекта "Робосборщик"
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Внесение изменений
## Installation
### В существующие страницы
Войти в директорию `docs/` и редактировать нужный документ:
`docs/doc-to-be-edited.md`
```markdown
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...
```
## Создание новых страниц
### Добавление новых страниц в существующие директории
1. Создайте документ с расширением .md в директории `/docs`, например `docs/newly-created-doc.md`(id должен совпадать с названием файла без расширения .md):
```md
---
id: newly-created-doc
title: Заголовок страницы
---
Новый контент..
```
1. Создайте ссылку на новый документ через id в боковое меню в файле `website/sidebars.json`:
```javascript
// Добавить документ newly-created-doc в раздел "Введение" в docs
{
"docs": {
"Введение": [
"quick-start",
"newly-created-doc" // сюда добавляется новый документ, название без .md
],
...
},
...
}
```
Дополнительная информация по редактированию контента [here](https://docusaurus.io/docs/en/navigation)
Этот сайт создан с помощью [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Установка
```console
yarn install
```
## Local Development
## Запуск сервера для локальной разработки
```console
yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Можно смотреть изменения в коде онлайн - перезапуск сервера не требуется
## Build
## Сборка
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Команда генерирует статический контект в директории `build`. Контент потом можно разместить как html на хостинге.