Витрина и поселение
Обновлено
Поселение приложения
Поселение связывает приложение с доменом и частью адреса сайта. Создайте для «Базы знаний» правило в настройках сайта Webasyst и выберите тему оформления.
Например, для правила docs/* адреса выглядят так:
| Экран | Пример адреса |
|---|---|
| Хаб всех разделов | /docs/ |
Раздел guide |
/docs/guide/ |
Статья install |
/docs/guide/install/ |
| Поиск | /docs/search/?query=установка |
docs/ — пример: используйте корень своего поселения.
Общее поселение или один проект
| Настройка | Что делает | Значения / по умолчанию |
|---|---|---|
| Выберите проект | Ограничивает поселение одним разделом | Без выбранного проекта — общий хаб; выбранный проект — его вступление в корне поселения |
В поселении одного проекта статья располагается сразу после корня, например /help/install/. Поиск такого поселения ограничен выбранным проектом.
Если на одном домене несколько подходящих поселений, при встраивании документации в чужую тему передайте точный base_url, чтобы получить нужные ссылки.
Что видит посетитель
На публичной витрине доступны опубликованные разделы и опубликованные статьи. Вступление _index выводится по адресу раздела, без отдельного пункта в меню.
Если вступление существует, но оставлено черновиком, опубликованный раздел продолжает открываться, однако черновой текст вступления не показывается.
Скрытие плитки главной не закрывает раздел. Статус «Черновик» у раздела закрывает его публичную страницу и статьи; по прямым адресам посетитель получает 404.
Предпросмотр
Добавьте ?preview=1 к адресу документации и войдите в Webasyst под пользователем с доступом к бэкенду приложения. Такой просмотр включает неопубликованные материалы и помечается как предпросмотр.
Параметр не открывает черновики анонимным посетителям. Для проверки публикации откройте адрес без авторизации и без параметра предпросмотра.