Раздел документации в формате Markdown
от Webdebug
Технические данные
Дата публикации:
20.06.2023
Версия:
23.0.0
Адаптивность:
Да
Поддержка композита:
Нет
Число установок:
Менее 50 раз
Описание
Модуль позволяет создать на сайте раздел документации (для программного продукта, товара, услуги и т.д.) с современным дизайном.Управление данными основано на инфоблоках - контент можно задавать как в разделах, так и в элементах. Формат описания - markdown, благодаря чему документация создаётся очень быстро и легко.
В качестве примера посмотрите раздел документации по данному модулю на нашем сайте: https://www.webdebug.ru/doc/webdebug.doc/
При этом важно отметить, что модуль, по сравнению с «чистым» Markdown, добавляет дополнительные возможности - галерея для картинок, вставка видео из YouTube (и других видеосервисов) и т.д.
Модуль изначально разрабатывался на PHP8, поэтому полностью поддерживает его.
Для данного модуля демо-режим не доступен (и не планируется), запустить установку можно только после оплаты - для этого следует на сайте (раздел Marketplace - Обновление решений - Активация купона) активировать полученный по email купон, после этого Битрикс сам предложит установить модуль.
При установке модуль предлагает автоматически установить публичные файлы (их также можно будет создать вручную позднее, но при установке - проще).
После установки перейдите в настройки модуля (это можно сделать разными способами, например в админке на любой странице нажмите кнопку «Настройки» (с шестерёнкой), а потом в выпадающем модуле выберите «Раздел документации»).
В настройках модуля необходимо создать отдельный инфоблок (тип инфоблока уже создан), здесь же можно настроить группировку инфоблоков, оформление и поиск.
Общий принцип структуры инфоблоков следующий: все инфоблоки должны быть только в одном типе - в том, который создал модуль. На каждую документацию нужно создать отдельный модуль (например, на каждый программный продукт или на каждое отдельное руководство).
Вся остальная работа проводится в инфоблоке, как обычно: разделы и элементы. Контент можно писать как в разделах, так и в элементах. Второй способ предполагает внутри каждого раздела создать элемент, в котором будет отмечена галочка «Индексная статья раздела» - такой элемент не будет считаться как отдельная статья, а только как текст для родительского раздела. Если такого элемента нет - текст раздела будет браться из самого раздела.
Рекомендуем попробовать оба варианта, чтобы выбрать наиболее удобный. Контент в разделах имеет некоторые ограничения: например, нельзя загружать картинки в доп. свойство, а только в анонс и подробно (в элементах можно использовать анонс, подробно и дополнительные картинки).
При установке модуль предлагает автоматически установить публичные файлы (их также можно будет создать вручную позднее, но при установке - проще).
После установки перейдите в настройки модуля (это можно сделать разными способами, например в админке на любой странице нажмите кнопку «Настройки» (с шестерёнкой), а потом в выпадающем модуле выберите «Раздел документации»).
В настройках модуля необходимо создать отдельный инфоблок (тип инфоблока уже создан), здесь же можно настроить группировку инфоблоков, оформление и поиск.
Общий принцип структуры инфоблоков следующий: все инфоблоки должны быть только в одном типе - в том, который создал модуль. На каждую документацию нужно создать отдельный модуль (например, на каждый программный продукт или на каждое отдельное руководство).
Вся остальная работа проводится в инфоблоке, как обычно: разделы и элементы. Контент можно писать как в разделах, так и в элементах. Второй способ предполагает внутри каждого раздела создать элемент, в котором будет отмечена галочка «Индексная статья раздела» - такой элемент не будет считаться как отдельная статья, а только как текст для родительского раздела. Если такого элемента нет - текст раздела будет браться из самого раздела.
Рекомендуем попробовать оба варианта, чтобы выбрать наиболее удобный. Контент в разделах имеет некоторые ограничения: например, нельзя загружать картинки в доп. свойство, а только в анонс и подробно (в элементах можно использовать анонс, подробно и дополнительные картинки).
Задать вопрос в техническую поддержку Вы можете:
- на нашем сайте www.webdebug.ru
- по электронной почте: info@webdebug.ru
- в Telegram: webdebug
Установите этот модуль прямо сейчас!
Для этого укажите адрес сайта:
пример: https://www.site.ru
Раздел документации в формате Markdown
6 900 руб
