Установка и локальная разработка

Документация для образовательного ровера BRover-E5, созданная с использованием Docusaurus.

Быстрый старт

1. Клонирование репозитория

git clone https://github.com/voltbro/brover-manual.git
cd brover-manual

2. Установка зависимостей

npm install

3. Запуск в режиме разработки

npm run start

После запуска сайт будет доступен по адресу http://localhost:3000

4. Сборка production-версии

npm run build

5. Очистка сборочной директории

npm run clear

Деплой через WinSCP

1. Установите WinSCP на компьютере с Windows.
2. Сохраните подключение к серверу в WinSCP под именем voltbro. Это имя сохранённого сеанса, а не адрес сервера или имя пользователя.
3. В каталоге проекта выполните:

npm run deploy:ftp

Журнал WinSCP сохраняется в deploy-winscp.log в корне проекта и исключён из Git. Если WinSCP завершится с ошибкой, скрипт сообщит об этом и укажет путь к журналу.

Структура проекта

• docs/ — директория с Markdown-файлами документации
• src/ — исходные коды React-компонентов
• static/ — статические файлы (изображения, CSS и т.д.)
• docusaurus.config.js — основной конфигурационный файл

Полезные команды

Команда	Описание
npm run start	Запуск dev-сервера с hot-reload
npm run build	Сборка статического сайта в папку build
npm run clear	Очистка сборочной директории
npm run serve	Локальный просмотр собранного сайта
npm run deploy:ftp	Сборка и публикация сайта через WinSCP