Это основанная на mdbook документация для разработчиков всех проектов Space Wizards, включая Robust Toolbox, Space Station 14, лаунчер SS14 и т. д. Эти документы охватывают множество тем и могут быть очень полезны для мапперов, спрайт-художников, активных и потенциальных контрибьюторов, людей, желающих использовать наш движок для своих проектов, разработчиков форков и так далее.
Сейчас сайт размещён по адресу https://docs.spacestation14.com.
Преимущества нынешней инфраструктуры сайта документации:
- Первоклассная поддержка git, открытый исходный код и возможность редактирования для всех
- Достаточно привычно и удобно для разработчиков, так как
mdbookочень широко используется - Не требуется инфраструктура входа или хостинг (кроме GH pages), если форки хотят размещать свои версии
- Очень низкий порог для добавления новых страниц и редактирования/исправления старых
- Высокая гибкость настройки оформления и простое добавление собственных скриптов
- Поддержка локализации в перспективе
Доступны и используются следующие функции и плагины mdbook:
- поддержка
MathJax - Боковое оглавление (встроенное прямо в
index.hbsи т. п.) mdbook-mermaidmdbook-linkcheckmdbook-templatemdbook-admonishmdbook-emojicodesmdbook-embedify
Информацию о том, как редактировать, собирать и тестировать эти документы, смотрите в Руководстве по редактированию документации на самом сайте (или в этом репозитории)
Под лицензией Mozilla Public License v2.0.

