О проекте
Введение
Представляем вашему вниманию документацию для компонентов MODX Revolution, открытую каждому.
Это бесплатный Open Source проект, размещённый на GitHub. Такое размещение, позволяет каждому дополнять страницы "Документации", делать форки, клонировать проект, сохраняя и изменяя по своему вкусу.
Принцип работы
"Документация" работает на технологии VitePress. Это статичные текстовые файлы, написанные на простеньком языке разметки md, с некоторыми "украшающими" добавками от VitePress. В отличие от "сухого" языка разметки md - мы получаем возможности размещать смайлики, подсвечивать и фокусироваться на важных элементах кода, добавлять красивые цветные Warning-блоки и ещё много чего.
Портал с документацией связан с нашим GitHub репозиторием. Предлагайте Ваши правки в виде Pull Request и после одобрения они мгновенно окажутся на сайте.
Авторы и участники проекта
Проект "Документация" принадлежит русскоязычному сообществу MODX в лице MODX RSC, разрабатывается и поддерживается на добровольной основе. Каждый из участников сообщества является равноправным совладельцем проекта и вносит свой посильный вклад.
Финансовая поддержка
Данный сервис является Open-Source проектом и его поддержка и развитие зависит от пожертвований. На пожертвования команда разработчиков может выделить больше времени для работы над экосистемой сообщества MODX.
Технологии сайта
Статический сайт собирается VitePress поверх Vite: Markdown в HTML, подсветка кода (Shiki), поиск, тёмная тема, встраиваемые диаграммы Mermaid. Репозиторий — обычный Node.js-проект: зависимости через pnpm / npm / yarn, скрипты в package.json.
С чего начать автору
| Задача | Раздел |
|---|---|
Клонировать репозиторий, PR, структура docs/ | Начало работы |
| Заголовки, списки, код в Markdown | Разметка markdown |
| Контейнеры, подсветка строк, группы вкладок | Возможности VitePress |
title, description, меню компонента | Frontmatter |
| Блок-схемы и sequence-диаграммы | Диаграммы Mermaid |
| Проверка орфографии перед публикацией | cspell |
Вопросы и правки по сайту
Обсуждения и баги документации как проекта — в Issues на GitHub. Предложения по тексту компонентов оформляйте привычным Pull Request в тот же репозиторий.