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

Этот компонент позволяет организовтаь раздел с множеством документаций, и поиску по ним

bxmaker:mdbase.item

Этот компоненты является комплексным также, он может быть испольвзован как в составе комопнента bxmaker:mdbase так и по отдельности. С его помощью можно вывести какую-то отдельную базу знаний или документацию.

bxmaker:mdbase.menu

Этот комопнент выводит меню конкретной документации, элементы и разделы. В процессе вывода в публичной части, меню дополняется с помощью JS пунктами, сформирвоанными на основе заголовков.

bxmaker:mdbase.list

Этот комопнент выводит список доступных документаций или баз знаний по заданному типу инфоблока. Он испольвуется в корневом разделе документации или базы знаний.

bxmaker:mdbase.detail

Это компонент выводит конкретную запись из документации или базы знаний на страницу.