Документация о расширении Discourse с помощью плагинов, тем и компонентов темы, работе с основным кодом и использовании API Discourse.
Введение
- Введение: Введение в разработку для Discourse
Среда разработки
- Dev Container: Разработка Discourse с использованием Dev Container
- GitHub Codespaces: Разработка Discourse в GitHub Codespaces
- Установка Docker: Установка Discourse для разработки с помощью Docker
- Установка на macOS: Установка Discourse на macOS для разработки
- Установка на Ubuntu/Debian: Установка Discourse на Ubuntu или Debian для разработки
- Установка на Windows: Установка Discourse на Windows для разработки
- Плагины без Docker: Установка плагинов в среде разработки без Docker
- Локальная установка: Настройка локальной среды разработки Discourse?
- Настройка мультисайта: Настройка среды разработки мультисайта
- Установка на Fedora: Настройка Discourse для разработки на Fedora Linux
Код и внутреннее устройство
- Компоненты Ember: Добавление компонентов Ember в Discourse
- UI kit: Набор общих компонентов, хелперов и модификаторов Discourse
- Линтинг и форматирование: Автоматический линтинг и форматирование кода перед коммитами
- Acceptance-тесты: Написание acceptance-тестов для кода Ember в Discourse
- Запуск тестовых наборов: Как запустить тестовые наборы QUnit для ядра, плагинов и тем Discourse
- Совместимость версий: Фиксация версий плагинов и тем для более старых установок Discourse (ветки d-compat)
- Владение объектами Ember: Владение объектами Ember (getOwner, внедрение сервисов и т. д.)
- Производительность JS: Использование «tachometer» от Google для измерения изменений производительности JS в Discourse
- CI с GitHub Actions: Настройка непрерывной интеграции (CI) с помощью GitHub Actions
- Расширения Markdown: Руководство разработчика по расширениям Markdown
- Конвертация модальных окон: Конвертация модальных окон из устаревших контроллеров в новый API компонента DModal
- API DModal: Использование API DModal для отображения модальных окон (всплывающих окон/диалогов) в Discourse
- JS API: Использование JS API
- Коннекторы Plugin Outlet: Использование коннекторов Plugin Outlet из темы или плагина
- modifyClass: Использование modifyClass для изменения поведения ядра
- Создание маршрутов: Создание маршрутов (Routes) в Discourse и отображение данных
- Метод аутентификации: Добавление нового «управляемого» метода аутентификации в Discourse
- Случайная сериализация моделей ActiveRecord: Предотвращение случайной сериализации моделей ActiveRecord
- Переопределение шаблонов: (не рекомендуется) Переопределение шаблонов Discourse из темы или плагина
- Объекты сервисов: Использование объектов сервисов в Discourse
- Системные спецификации: Написание сквозных системных спецификаций (end-to-end system specs) для пользовательского интерфейса Discourse
- FormKit: Инструменты Discourse для отрисовки форм.
- Триггеры AppEvents: Справочник триггеров AppEvents
- Трансформеры: Использование трансформеров для настройки значений и поведения на стороне клиента
- Кастомизация списка тем: Кастомизация списка тем
- Руководство по CSS: Руководство по классам CSS с использованием методологии BEM
- Подсказки типов и валидация JS: Подсказки типов и валидация JavaScript (typescript)
- Проектирование для устройств: Проектирование для разных устройств (Touch & Hover)
- Проектирование для адаптивной ширины: Проектирование для адаптивной ширины (брейкпоинты, viewport и контейнеры)
- Примитивы жестов: Примитивы перетаскивания, изменения размера и жестов
- Разбиение бандла: Разбиение бандла для плагинов
- Приватные модули: Приватные модули и соглашение
-internals - Тесты компонентов: Написание тестов компонентов для Discourse
Плагины
- Базовый плагин: Разработка плагинов Discourse — Часть 1 — Создание базового плагина
- Plugin Outlet: Разработка плагинов Discourse — Часть 2 — Подключение к плагину-выходу (plugin outlet)
- Настройки сайта: Разработка плагинов Discourse — Часть 3 — Добавление пользовательских настроек сайта
- Настройка Git: Разработка плагинов Discourse — Часть 4 — Настройка git
- Интерфейс администратора: Разработка плагинов Discourse — Часть 5 — Добавление интерфейса администратора
- Acceptance-тесты: Разработка плагинов Discourse — Часть 6 — Добавление acceptance-тестов
- Публикация плагина: Разработка плагинов Discourse — Часть 7 — Публикация вашего плагина
- Новые локали: Добавление новой локали из плагина
- Интеграция с чатом: Добавление нового провайдера в discourse-chat-integration
- Расширение markdown-it: Переупаковка расширения markdown-it как плагина Discourse
- Автозагрузка Rails: Структурирование плагина для автозагрузки в Rails
Темы и компоненты
- Разработка тем: Разработка тем и компонентов тем Discourse
- Краткое справочное руководство: Краткое справочное руководство разработчика тем
- Руководство для дизайнеров: Руководство для дизайнеров по началу работы с темами в Discourse
- Theme Creator: Начало работы с Theme Creator и Theme CLI
- Theme CLI: Установка консольного приложения Discourse Theme CLI для помощи в создании тем
- Структура темы: Структура тем и компонентов тем
- Несколько JS-файлов: Разделение JavaScript темы на несколько файлов
- Несколько SCSS-файлов: Разделение SCSS темы на несколько файлов
- Настройки темы: Добавление настроек в вашу тему Discourse
- Объекты для настроек темы: Тип объекта для настройки темы
- Миграция настроек: Миграция настроек темы Discourse
- Метаданные темы: Добавление метаданных и скриншотов к теме
- Переменные ядра: Использование переменных ядра Discourse в вашей теме
- Локализуемые строки: Добавление локализуемых строк в темы и компоненты тем
- E2E-тестирование: Сквозное системное тестирование тем и компонентов тем
- Минимизация обслуживания: Минимизация затрат на обслуживание кастомизаций тем
- Размеры шрифтов: Изменение размеров шрифтов в ваших темах
- Включение ассетов: Включение ассетов (например, изображений, шрифтов) в темы и компоненты
- Пользовательские иконки: Замена стандартных SVG-иконок Discourse на пользовательские иконки в теме
- Темный режим: Обновление тем и плагинов для поддержки автоматического темного режима
- Модификаторы темы: Модификаторы темы: краткое введение
- Псевдоэлементы: Вставка текста или изображений в любое место вашего сайта с помощью псевдоэлементов CSS
- Компонент шрифта: Создание и публикация компонента темы со шрифтом
- Язык Highlight.JS: Установка нового языка для Highlight.JS через компонент темы
- Контент главной страницы: Добавление пользовательского контента, который появляется только на вашей главной странице
- Формат сообщений: Поддержка формата сообщений (Message Format) для локализации
- Глобальные изменения иконок: Глобальное изменение иконок
- Альтернативные иконки: Альтернативные иконки
- Стиль вики-сообщения: Изменение стиля вики-сообщения
- Цветовая схема: Создание и публикация цветовой схемы
- Меню навигации: Использование параметра запроса
navigation_menuдля предпросмотра боковой панели или других опций - Стили контента сообщений: Кастомизация содержимого сообщений с помощью собственных стилей
- Скриншоты темы: Добавление предпросмотров скриншотов к темам Discourse
- Настраиваемые настройки сайта: Управление настройками сайта с помощью тем
Общие руководства
- Белая маркировка мобильных приложений: Важные моменты, которые следует учесть перед решением о белой маркировке мобильных приложений Discourse
- Пользовательские автоматизации: Создание пользовательских автоматизаций (Automations)
- Публичный дамп данных: Публичный дамп данных Discourse
- AI evals: Запуск оценок (evals) AI в Discourse
- AI-бот через API: Использование AI-бота через API Discourse
Учебник по разработке тем
- 1 - Введение: Учебник разработчика тем: 1. Введение
- 2 - Удаленная тема: Учебник разработчика тем: 2. Создание удаленной темы
- 3 - CSS: Учебник разработчика тем: 3. CSS в темах
- 4 - Выходы (Outlets): Учебник разработчика тем: 4. Использование выходов (outlets) для вставки и замены контента
- 5 - Компоненты: Учебник разработчика тем: 5. Создание и использование компонентов
- 6 - JS API: Учебник разработчика тем: 6. Использование JS API
- 7 - Заключение: Учебник разработчика тем: 7. Подведение итогов