Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 3.11 KB

README-ru.md

File metadata and controls

39 lines (28 loc) · 3.11 KB

Язык README:
En Ru

Wiki для разработчиков Space Wizards

Это документация для разработчиков всех проектов Space Wizards на основе mdbook, включая Robust Toolbox, Space Station 14, лаунчер SS14 и другие. Эти документы охватывают множество тем и могут быть полезны для мапперов, спрайтеров, активных и потенциальных участников, людей, желающих использовать наш движок для собственных проектов, разработчиков форков и других.

Сайт с документацией доступен по адресу: https://docs.spacestation14.com.

Преимущества текущей инфраструктуры сайта с документацией:

  • Полноценная поддержка git, открытый код, который действительно могут редактировать все
  • Привычный и удобный инструмент для разработчиков, поскольку mdbook широко используется
  • Отсутствие необходимости в регистрации или настройке хостинга (достаточно страниц GitHub), если форки хотят разместить собственную версию
  • Минимальные усилия для добавления новых страниц и редактирования/исправления старых
  • Высокий уровень кастомизации стиля и простота добавления пользовательских скриптов
  • Планируемая поддержка локализации

Доступные и используемые возможности и плагины mdbook:

  • Поддержка MathJax
  • Боковое оглавление (интегрировано непосредственно в index.hbs и другие файлы)
  • Плагин mdbook-mermaid
  • Плагин mdbook-linkcheck
  • Плагин mdbook-template
  • Плагин mdbook-admonish
  • Плагин mdbook-emojicodes
  • Плагин mdbook-embedify

Информацию о том, как редактировать, собирать и тестировать эту документацию, можно найти в Руководстве по редактированию документации (или в этом репозитории).

Скриншоты

Лицензия

Wiki для разработчиков Space Wizards выпущена под лицензией Mozilla Public License v2.0.