Вклад

Этот сайт написан людьми, которые его используют.Каждая страница на нем начиналась как , кто-то что-то придумывал, а затем находил время, чтобы это записать.

Эта страница представляет собой локальную настройку, от начала до конца.Вам не нужно ничего из этого, чтобы исправить опечатку или сообщить о чем-то неладном — Методы внесения вклада охватывает более быстрые маршруты, и ни один из них ( ) не включает терминал.Прочтите термины и правила , прежде чем открывать запрос на включение в любом случае.

Что вам нужно

• Node.js 18 или новее
• Гит
• AУчетная запись GitHub
• — редактор — репозиторий настроен для VS Code

Необходимые инструменты содержит примечания по установке и конфигурацию первого запуска для каждого из них.

Настройте локально

Форк хранилище на GitHub, затем клонируйте свою вилку и установите:

git clone https://github.com/YOUR-USERNAME/Unofficial-Mordhau-Documentations.git
cd Unofficial-Mordhau-Documentations
npm install

Запустите сервер разработки:

npm run docs:dev

Он печатает адресон обслуживается, как правило, на http://localhost:5173.Оставьте включенным — страницы перезагружаются при сохранении.

Внесите изменения

Работайте в ветке, а не в main:

git checkout -b fix-rcon-ports

Страницы находятся под именем docs/<language>/, поэтому страница на английском языке принадлежит docs/en/. Для новой страницы также требуется запись в .vitepress/config.mts, иначе на сайте ничего не ссылается на нее.

Как использовать Markdownохватывает соглашения о файле и фирменный стиль.Что такое VitePress описывает файл конфигурации и то, как проект сочетается друг с другом.

Проверьте его перед отправкой

npm run docs:build

Сборка завершается с ошибкой из-за неработающих внутренних ссылок.Это самая простая ошибка, которую можно совершить ( ), и которую легче всего пропустить при предварительном просмотре, поэтому стоит запустить даже однострочное изменение .Если он пройдет успешно, npm run docs:preview будет служить именно тем, что создала сборка .

Отправить

git add .
git commit -m "Correct the RCON port numbers"
git push origin fix-rcon-ports

GitHub предлагает открыть запрос на извлечение из этой ветки при следующем посещении репозиторий.Скажите, что изменилось и почему.

Если обзор возвращается с просьбой о чем-то, отправьте еще один коммит в ту же ветку — запрос на включение обновится сам.После объединения Netlify перестраивает и публикует сайт, что занимает минуту или две.