robossembler.org/README.md

79 lines
2.3 KiB
Markdown
Raw Normal View History

# Документация проекта "Робосборщик"
2021-04-02 14:38:59 +03:00
## Внесение изменений
2021-04-02 14:38:59 +03:00
### В существующие страницы
2021-04-02 14:38:59 +03:00
Войти в директорию `docs/` и редактировать нужный документ:
`docs/doc-to-be-edited.md`
```markdown
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...
2021-04-02 14:38:59 +03:00
```
## Создание новых страниц
2021-04-02 14:38:59 +03:00
### Добавление новых страниц в существующие директории
1. Создайте документ с расширением .md в директории `/docs`, например `docs/newly-created-doc.md`(id должен совпадать с названием файла без расширения .md):
```md
---
id: newly-created-doc
title: Заголовок страницы
---
Новый контент..
```
2021-05-25 20:10:58 +00:00
1. Создайте ссылку на новый документ через id в боковое меню (файл `sidebars.js`):
```javascript
2021-05-25 20:10:58 +00:00
// Добавить документ newly-created-doc в соответствующий раздел docs (в данном случае 'Робосборщик')
module.exports = {
docs: [
{
type: 'category',
label: 'Робосборщик',
items: [
'robossembler-overview',
'plan',
"newly-created-doc" // сюда добавляется название нового документа без .md
],
},
],
};
2021-04-02 14:38:59 +03:00
```
Дополнительная информация по редактированию контента [here](https://docusaurus.io/docs/en/navigation)
Этот сайт создан с помощью [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
2021-04-02 14:38:59 +03:00
## Установка
2021-04-02 14:38:59 +03:00
```console
yarn install
2021-04-02 14:38:59 +03:00
```
## Запуск сервера для локальной разработки
2021-04-02 14:38:59 +03:00
```console
yarn start
```
Можно смотреть изменения в коде онлайн - перезапуск сервера не требуется
## Сборка
2021-04-02 14:38:59 +03:00
```console
yarn build
2021-04-02 14:38:59 +03:00
```
Команда генерирует статический контект в директории `build`. Контент потом можно разместить как html на хостинге.