Rubaro Docs

Русскоязычная документация по созданию модов для игры Barotrauma. Планируется описание:

• XML
• Lua
• Редактора подлодок
• Редактора персонажей

Руководство по документированию

Заголовок

Каждый документ должен начинаться с секции заголовка, содержащей матаданные для навигации по сайту.
Следуйте структуре ниже:

---
title: Оптимизация
sidebar_label: Оптимизация
sidebar_position: 4
slug: /performance
hide_table_of_contents: false
pagination_prev: null
---

• title: Заголовок страницы
• sidebar_label: Имя страницы в сайдбаре слева
• sidebar_position: Расположение страницы по счёту
• slug: короткая ссылка на страницу
• hide_table_of_contents: Спрятать таблицу содержания (правый сайдбар)
• pagination_prev: Наличие быстрого перехода на предыдущую страницу в конце текущей страницы
• pagination_next: Наличие быстрого перехода на следующую страницу в конце текущей страницы

Caution

Заголовки должны быть уникальными дабы избежать дальнейших проблем с индексацией страниц

Стратегия ссылок

Используйте абсолютные пути, начиная с корня директории документации.

Правильно

'/docs/xml/intro.md'

Неправильно

'../../docs/xml/howto.md'

./docs/xml/performance.md'

Стратегия изображений

• Все изображения должны быть на русском языке кроме случаев, когда источник/оригинал изображения не имеет версии на русском языке.
• Фон изображений должен быть замазан либо удалён.
• Файлы изображений должны иметь уникальные названия в PascalCase регистре.
• Несколько изображений одной категории должны иметь одно название, за которым следует номер или поясняющее слово.
• Изображения должны подходить для тёмной темы сайта.
• На изображениях не должно быть указано персональных или конфиденциальных данных.
• Все изображения должны быть размещены в директории /img

Contribution Guidelines

1. Сделайте fork репозитория и создайте новую ветку с вашими изменениями.
2. Напишите документацию, следуя руководству выше.
3. Создайте Pull Request с понятным описанием изменений на русском языке.
4. Придерживайтесь «Соглашения о коммитах».

Руководство по локальному тестированию

Убедитесь, что у вас установлен Node.js 22.12.0 и NPM 10.9.0

1. Склонируйте или скачайте репозиторий и расположите в любом удобном для вас месте.
2. Откройте командную строку, Git Bash или иной подобный инструмент в директории.
3. Используйте команду npm install для установки всех недостающих пакетов.
4. Используйте команду npm run start для запуска и отображении документации в реальном времени.