new

mxLocDoc

Просмотр локальной Markdown-документации проекта в админке MODX
Версия 2.0.2-pl
Дата выпуска 07.08.2026
Загрузки 4
Просмотры 203
mxLocDoc — лёгкий extra для просмотра локальной проектной документации прямо в админке MODX. Документация хранится в Markdown-файлах на диске, путь задаётся системной настройкой.

Возможности:
— чтение Markdown из локальной папки;
— левая навигация из manifest (_sidebar.json / mxlocdoc.json) или автоматически по файлам;
— безопасный серверный рендер Markdown;
— относительные картинки и ассеты через защищённый connector;
— поиск по документации с кэшированием;
— мультиязычные папки (en, ru, ...).

Без Node, Vue и сборки фронтенда. Пакет доступен для MODX 2 (версия 1.x) и MODX 3 (версия 2.x).

mxLocDoc Changelog

2.0.2-pl

  • Исправлено: документ не открывался, если в title его front matter была строчная кириллическая «х» — сервер отдавал пустой ответ, а вьюер показывал «Не удалось загрузить документ». PCRE в 8-битном режиме считает переводом строки байт 0x85 (NEL), а это второй байт «х» в UTF-8 (D1 85): строка title: Механики сайта разрывалась внутри буквы, заголовок получался оборванным на середине символа, json_encode на таком UTF-8 возвращал false — и ответ уходил пустым. Все выражения по front matter теперь считают переводом строки только CR, LF и CRLF.

2.0.1-pl

  • Добавлено: якоря в ссылках. [текст](./doc.md#раздел) открывает документ и прокручивает панель к нужному разделу, [текст](#раздел) прокручивает текущий документ, не трогая адрес страницы и не сдвигая саму админку. Слаг якоря и id заголовка считаются одинаково, id проставляются заголовкам с первого по шестой уровень (в оглавление справа по-прежнему идут только первые три), а неизвестный якорь просто открывает документ с начала.
  • Добавлено в документацию: разделы про якоря и про общий каталог картинок в корне документации (![x](/assets/file.png)) — в руководстве по синтаксису Markdown, ru и en.
  • Исправлено: в просмотре документа не было видно маркеров у маркированных списков и номеров у нумерованных. ExtJS-ресет админки (ext-all-notheme-min.css) гасит list-style глобально, поэтому вьюер теперь возвращает маркеры явно — вместе с отступами пунктов и вложенных списков.

2.0.0-pl

  • Порт mxLocDoc на MODX Revolution 3. Релиз рассчитан только на MODX 3; линия под MODX 2 остаётся на 1.0.0-pl.
  • Сервисы переписаны на PSR-4 (MxLocDoc\\) с автозагрузкой composer и регистрацией в контейнере $modx->services через bootstrap.php.
  • Процессоры, контроллер и коннектор переведены на пространства имён MODX 3.
  • Пакет собирается глобальным сборщиком modxapp, конфигурация — в package_builder/.

Последние обсуждения в сообществе MODX.pro