Space Stories Development Wiki

Это документация разработчика на основе mdbook для всех проектов Space Stories.

Этот сайт можно найти по адресу https://docs.spacestories.club.

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

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

Эти mdbook функции и плагины доступны и используются:

• MathJax поддержка
• Содержание боковой панели (интегрировано непосредственно в index.hbs и т. д.)
• mdbook-mermaid
• mdbook-linkcheck
• mdbook-template
• mdbook-admonish
• mdbook-emojicodes

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

License

Space Stories Development Wiki выпускается под лицензией Mozilla Public License v2.0.