Справка
Технические спецификации и контракты
Справка
Опубликовано здесь
- Контракты компонентов обязательные правила для атомов, механик и контейнеров
- API программный интерфейс
- Стилизация переменные и темы
Живёт в репозитории
Эти документы намеренно не продублированы на сайте: у них один источник в дереве, и копия разъехалась бы.
| Что | Файл |
|---|---|
| Архитектура, EventBus, ленивая загрузка | docs/ARCHITECTURE.md |
| Реестр атомов и как добавить атом | docs/ATOMS.md |
| Реестр механик | docs/MECHANICS.md |
| Схемы YAML и JSON, формат событий | docs/DATA-STRUCTURES.md |
| Сессии и localStorage | docs/SESSION.md |
| Иллюстрации, буквица, метки достоверности | docs/ILLUSTRATIONS.md |
| Создание урока, трека, пути, сценария | docs/CONTENT.md |
Источник истины
Если код и документация расходятся, верь коду.
| Что | Где |
|---|---|
| Список атомов и критерии выбора | data/atoms.yaml |
| Классы атомов | site/src/atoms/{universal,math,code,immersive,visual}/ |
| Список механик | site/src/mechanics/ |
| Список шорткодов | layouts/shortcodes/ |
| Базовый класс | site/src/atoms/_core/Component.js |
| EventBus | site/src/core/event-bus.js |
Для кого
Разработчики компонентов, авторы контента и контрибьюторы.