Работа с сайтом документации

Этот документ описывает процесс локальной разработки, сборки и публикации сайта документации HSM, построенного на базе Docusaurus.

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

Сайт находится в директории website/.

• docs/ — исходные тексты документации в формате Markdown.
• static/ — статические файлы (изображения, favicon).
• docusaurus.config.ts — основной файл конфигурации (название, URL, навигация).
• sidebars.ts — конфигурация боковой панели (по умолчанию генерируется автоматически).

Подготовка окружения

Для работы с сайтом требуется Node.js (версия 18 или выше) и npm.

1. Перейдите в директорию сайта:

   cd website

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

   npm install

Команды разработки

Локальный запуск

Запускает сервер разработки с поддержкой Hot Reload (изменения видны сразу после сохранения файлов).

npm start

Сайт будет доступен по адресу: http://localhost:3000

Сборка (Build)

Компилирует сайт в статические HTML/JS/CSS файлы для продакшена.

npm run build

Результат сборки сохраняется в папку build/.

Предпросмотр сборки

Запускает локальный сервер для проверки уже собранного статического сайта.

npm run serve

Публикация (Deployment)

Сайт настроен для публикации на GitHub Pages по адресу https://vlmhyperbenchteam.github.io/hsm/.

Ручной деплой

Для публикации актуальной версии сайта выполните команду:

# Если вы используете SSH для Git
USE_SSH=true npm run deploy

# Если вы используете HTTPS
npm run deploy

Команда автоматически:

1. Соберет проект (npm run build).
2. Создаст/обновит ветку gh-pages в репозитории.
3. Запушит изменения на GitHub.

Рекомендации по наполнению

1. Имена файлов: Используйте kebab-case для имен файлов (например, my-new-doc.md). Это обеспечит красивые и понятные URL.
2. Изображения: Размещайте изображения в hsm/website/static/img/ и ссылайтесь на них как /img/filename.png.
3. Внутренние ссылки: Используйте относительные пути к файлам, например [ссылка](../getting-started/installation.md). Docusaurus автоматически преобразует их в правильные URL.