Как работает модуль?

При установке создаётся компонент webdebug:doc - он реализует весь раздел документации, включая стартовую страницу с выбором инфоблоков, страницы раздела и элемента, страницу поиска. Компонент по умолчанию работает в ЧПУ-режиме.

На сайте компонент отбирает инфоблоки, привязанные к данному сайту, каждый из которых считается отдельным курсом.

Каждый раздел считается отдельным подразделом документации, а каждый элемент - либо отдельной статьёй документации, либо просто описанием для родительского раздела, если в ней отмечена галочка «Индексная статья раздела» (при этом, если используются иконки и для раздела она не задана, она будет взята из элемента).

Рекомендуем описания разделов не использовать, а задавать их в индексном элементе. Это иногда может быть не очень удобно (а иногда - даже наоборот), но даёт некоторые преимущества: в элементах можно загружать сколько угодно изображений, в то время как в разделе - только два (анонс и подробно). Также это способствует единообразию (чтобы смотреть текст не нужно гадать где он задан - в разделе или в элементе).

Также, важный момент: счётчик просмотров (иконка глаза под заголовком статьи) работает только для статей. Для разделов это не работает!

Контент в разделах и элементах задаётся в формате Markdown - это очень простой язык разметки для быстрого составления статей, в который также можно добавлять HTML-код.