mxLocDoc
Просмотр локальной Markdown-документации проекта в менеджере MODX Revolution 2 и 3 — навигация из манифеста, безопасный рендер, защищённые ассеты, поиск с кэшем, языки.
Системные настройки
mxLocDoc настраивается через системные настройки MODX в пространстве mxlocdoc.
| Настройка | По умолчанию | Назначение |
|---|---|---|
mxlocdoc.docs_path | [[+corePath]]components/mxlocdoc/docs/ | Локальный корень Markdown-документации. |
mxlocdoc.languages | en,ru | Список кодов языков через запятую, для которых включается мультиязычность. Пустое значение — моно-режим. См. раздел «Языки». |
mxlocdoc.default_file | README.md | Файл, который открывается как index папки. |
mxlocdoc.nav_file | _sidebar.json | Основной манифест навигации. |
mxlocdoc.search_enabled | Да | Включает live-поиск. |
mxlocdoc.cache_ttl | 300 | Время жизни кэша поискового индекса в секундах. 0 — без кэша. |
mxlocdoc.max_file_size | 1048576 | Максимальный размер Markdown-файла или ассета (в байтах). |
mxlocdoc.allowed_asset_extensions | jpg,jpeg,png,gif,webp,svg | Расширения ассетов, которые можно отдавать через защищённый connector. |
Плейсхолдеры пути
Используйте [[+corePath]] для переносимых путей:
text
[[+corePath]]components/project-docs/Абсолютные пути тоже разрешаются для совместимости, но не рекомендуются для распространяемой конфигурации пакета.