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

Установка и первые шаги

Обновлено

Установка

Когда приложение будет доступно в маркете Webasyst, установите «Базу знаний» через «Установщик». До публикации карточки установка из маркета недоступна.

После установки откройте «База знаний» в списке приложений Webasyst. Если доступ запрещён, администратору нужно предоставить пользователю доступ к этому приложению.

Первый раздел

  1. Откройте «Все разделы» и нажмите «Новый раздел».
  2. Заполните «Заголовок» и «Адрес страницы». Адрес подставляется из заголовка, пока вы не изменили его вручную.
  3. При необходимости добавьте теги. Дополнительные поля доступны в «Дополнительные настройки проекта».
  4. Нажмите «Создать». Вместе с разделом появится стартовая страница _index — вступление раздела.
  5. Откройте «Настройки раздела», заполните «Вступление (Markdown)» и сохраните.
  6. Создайте «Новую главу», затем «Новую статью». У новой статьи сначала задаются заголовок, адрес, глава и статус. Нажмите «Создать»: после этого станет доступно поле «Содержание (Markdown)».
  7. Напишите текст, проверьте его в «Предпросмотр» или «Рядом» и нажмите «Сохранить».

Новые разделы и статьи создаются со статусом «Черновик». Для публикации установите «Опубликовано» у раздела и нужной статьи, затем сохраните изменения. Переключение статуса раздела также меняет статус его вступления, но не публикует все обычные статьи.

Подключение адреса и оформления

Создайте поселение приложения «База знаний» в настройках сайта Webasyst, например docs/*. Для общей главной страницы оставьте параметр «Выберите проект» без выбранного раздела. Подробнее — «Витрина и поселение».

В «База знаний → Настройки хаба» задайте тексты главной и проверьте плитку раздела. В «Темы дизайна» выберите оформление и настройте блоки главной.

Проверка результата

Откройте раздел кнопкой «Открыть на сайте». Черновая статья открывается с ?preview=1 для пользователя с доступом к приложению.

Затем откройте опубликованный адрес в отдельном окне без авторизации. Проверьте вступление, статью, меню глав, поиск и плитку на главной. Черновики в таком окне видны быть не должны.