Skip to content
mxLocDoc
mxLocDoc
Просмотр локальной Markdown-документации проекта в менеджере MODX Revolution 2 и 3 — навигация из манифеста, безопасный рендер, защищённые ассеты, поиск с кэшем, языки.
  1. Компоненты
  2. mxLocDoc
  3. Языки

Языки

mxLocDoc поддерживает мультиязычную документацию, но языки задаются явно — настройкой mxlocdoc.languages. Автоматического определения языковых папок нет.

Как включить

  1. Перечислите коды языков в настройке mxlocdoc.languages через запятую, например en,ru (значение по умолчанию).
  2. Внутри mxlocdoc.docs_path создайте подпапку под каждый код с Markdown-доками:
text
docs/
├── en/
│   ├── _sidebar.json
│   └── README.md
└── ru/
    ├── _sidebar.json
    └── README.md

Код из настройки становится активным языком, только если такая подпапка существует и содержит Markdown-файлы. Коды без папки просто игнорируются.

Моно-режим

Если mxlocdoc.languages пустая, mxLocDoc работает в одноязычном режиме: корнем считается сам mxlocdoc.docs_path, языковые подпапки не выделяются, переключатель языка скрыт. Обычная двухбуквенная папка раздела (например ui, js) языком не становится — язык включается только через настройку.

Переключатель и язык по умолчанию

  • Переключатель показывается, только если активных языков больше одного.
  • По умолчанию выбирается первый подходящий вариант: запрошенный язык → язык интерфейса менеджера → языковой ключ (culture key) сайта → первый доступный по алфавиту.
  • Выбор сохраняется и передаётся во все запросы: навигацию, документ, поиск и ассеты.