Работа с плагином редактирования документации#

Плагин доступен только аутентифицированным пользователям. Он позволяет сохранять и редактировать документацию в собственном хранилище (БД). Документы состоят из одного или нескольких Markdown-файлов. Каждый документ начинается со стартовой страницы «index.md».

Для редактирования документации на объект каталога перейдите в его карточку и выберите «Редактировать документацию» в контекстном меню. Для этого необходимо, чтобы ACL разрешал операцию «plugin.documents.owner» на объект каталога.

В верхней части окна редактирования находится селектор, в выпадающем списке которого можно выбрать файл для редактирования.

После изменения содержания документации в редакторе необходимо нажать кнопку «Сохранить».

Чтобы добавить в документ новый файл, в поле селектора необходимо ввести название. В меню выпадающего списка будет предложено создать новую файл.

После изменений в редакторе необходимо нажать на кнопку «Сохранить». Новый файл будет отображаться в выпадающем списке селектора и будет доступен для редактирования.