Деплой сайта

Сайт — статические файлы Docusaurus на Timeweb. Timeweb сам собирает и выкладывает сайт после каждого push в ветку master репозитория ShalunBdk/helgawind_docs. Вручную загружать ничего не нужно.

Выложить изменения

cd "E:/HelgaWind/helgawind_docs"
npm run build              # проверка: сборка должна пройти без ошибок
git add <файлы>
git commit -m "docs: ..."
git push origin master     # Timeweb подхватит и выложит сам

Через несколько минут после push изменения на сайте. Если не появились — смотреть статус сборки в панели Timeweb.

Проверка перед push

npm run build
npm run serve

npm run build собирает сайт в папку build/ и падает на битых ссылках и ошибках в markdown — лучше узнать об этом до push. npm run serve поднимает локальный сервер на собранных файлах — то же самое, что увидят пользователи. Проверить, что все три раздела навбара открываются и сайдбары не пустые.

Папка build/ в git не попадает, её собирает Timeweb.

Новая страница

1. Файл .md в streamer-docs/, moderation-docs/ или admin-docs/.
2. Имя файла без .md — в нужный сайдбар: sidebars.streamer.js, sidebars.moderation.js или sidebars.admin.js. Порядок в списке — порядок в меню.
3. Сборка, commit, push.

Адрес сайта

baseUrl в docusaurus.config.js — /, сайт показывается с корня домена. Если сайт переедет на подпуть (например /helgawind-docs/), поменять baseUrl на этот путь, иначе внутренние ссылки будут вести не туда.