Markdown документация, база знаний
Модуль позволяет организовать документацию или базу знаний на сайте с использованием Markdown-формата текста. Этот вариант сокращает время добавления текста, так как не надо оборачивать его в HTML-теги, итоговое форматирование текста будет единым по всей документации или базе знаний.
Каждая отдельная документация или база знаний хранится в своём инфоблоке.
В публичной части заголовки записи размечены якорями, что позволяет отправить ссылку на конкретный блок документации или базы знаний, чтобы пользователь не искал решение по всей странице.
Базовая установка модуля стандартная, пример описан здесь.
В процессе установки предлагается два варианта:
Рекомендуется выбирать 2-й вариант, так как в процессе установки будет создан и тип инфоблоков, и сам инфоблок, и раздел. Также будут размещены компоненты и добавлена привязка шаблона документации или базы знаний к сайту.
Данные хранятся в инфоблоках с поддержкой разделов. Вместо стандартного редактора подключается упрощённый редактор для набора текста и просмотра готового результата тут же.
В редакторе есть возможность выбрать картинку из медиабиблиотеки, что позволяет хранить структурированно картинки и использовать их в документации или базе знаний.
При добавлении записей можно указать метатеги для записи на вкладке SEO.
Благодаря использованию инфоблоков можно гибко настроить уровень доступа к документации или базе знаний для той или иной группы пользователей. Таким образом можно дать доступ к базе знаний только конкретной группе пользователей, например менеджерам, а обычным пользователям она будет недоступна.
Для отображения документации или базы знаний, как запланировал разработчик, вместе с модулем поставляется шаблон сайта с названием bxmaker.mdbase. В его стилях и скриптах заложен функционал для публичной части сайта. Рекомендуется использовать именно этот шаблон, так как все стили для компонентов хранятся в стилях шаблона.
Чтобы изменить логотип в шаблоне, нужно в настройках модуля для конкретного сайта загрузить нужный логотип.
Ссылка с логотипа по умолчанию ведёт на корневой адрес сайта — /.
Слово «документация» может быть заменено без правки шаблона, для этого необходимо задать свойство раздела, в котором размещена документация или база знаний. Нужно либо через публичную часть указать другое название через свойства раздела, либо вручную в исходном коде страницы. Код свойства — MDBASE_ROOT_NAME.
$APPLICATION->SetDirProperty('MDBASE_ROOT_NAME', 'База знаний');
Ссылка по умолчанию указана как /doc/, чтобы её изменить достаточно указать свойство раздела с кодом MDBASE_ROOT_URL.
$APPLICATION->SetDirProperty('MDBASE_ROOT_URL', '/custom_doc/');
С модулем поставляется 5 компонентов, 2 из которых комплексные.
Этот компонент позволяет организовать раздел с множеством документаций и поиском по ним.
Этот компонент является комплексным также, он может быть использован как в составе компонента bxmaker:mdbase, так и по отдельности. С его помощью можно вывести какую-то отдельную базу знаний или документацию.
Этот компонент выводит меню конкретной документации, элементы и разделы. В процессе вывода в публичной части меню дополняется с помощью JS пунктами, сформированными на основе заголовков.
Этот компонент выводит список доступных документаций или баз знаний по заданному типу инфоблока. Он используется в корневом разделе документации или базы знаний.
Этот компонент выводит конкретную запись из документации или базы знаний на страницу.