К содержимому
Начало работы

Обзор

Обновлено

Для чего нужна «База знаний»

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

Материалы организованы в проекты. В русскоязычном бэкенде они называются разделами. Внутри раздела есть вступление, главы и статьи. Глава группирует статьи в меню; статья может находиться и без главы.

Возможности

  • Редактор Markdown с режимами «Исходник», «Предпросмотр» и «Рядом».
  • Черновики разделов и статей, публикация и авторизованный просмотр на сайте.
  • Сортировка глав и статей, перенос статей между главами и разделами.
  • Общая главная страница — хаб с плитками разделов и фильтром по тегам проектов.
  • Поиск по названиям, описаниям и текстам статей с живыми подсказками.
  • SEO-поля, Open Graph, канонические адреса, микроразметка и карта сайта.
  • Самостоятельная тема «База знаний» со светлой и тёмной схемами и настройками блоков главной.
  • Хелпер {$wa->code->…} для вывода документации в темах других приложений.
  • Импорт подготовленного снимка документации через CLI.

Для управления документацией через ИИ-агента предусмотрен отдельный плагин «База знаний для MCP». Он продаётся отдельно; подключение описано в статье о MCP.

Редакции

Разделения возможностей приложения на стандартную и премиум-редакцию нет. Плагин для MCP — отдельное дополнение.

Требования

Компонент Требование
PHP 7.4 или новее
Расширения PHP JSON, Fileinfo, DOM, Mbstring
Приложение «Установщик» Webasyst 2.7.0 или новее
Интерфейс бэкенда Webasyst UI 2.0

Для публикации нужен адрес приложения на сайте — поселение. Для чтения опубликованных материалов авторизация не требуется. Для редактирования и просмотра черновиков нужен доступ к бэкенду приложения.