Документерра: руководство пользователя

Брендинг: Общая информация

Брендинг сегодня - это гораздо больше, чем просто визуальный образ. Поэтому невозможно переоценить, насколько важно, чтобы стиль документации соответствовал общему дизайну вашей компании. Документерра позволяет добавить логотип компании, использовать принятую в компании цветовую схему, шрифты и так далее. На этой странице вы можете ознакомиться с брендинговыми возможностями Документерры.

Что можно брендировать в Документерре

Поскольку порталом Документерра будут пользоваться и авторы, и читатели, обратите внимание:

Contributor UI can't be branded.
Авторы после входа на портал используют стандартный пользовательский интерфейс (UI). Этот пользовательский интерфейс нельзя брендировать.
Читательский интерфейс брендировать можно.
Вы можете брендировать различные элементы читательского интерфейса, включая, но не ограничиваясь:
- Домашнюю страницу портала,
- Читательское меню с логотипом,
- Шаблон читательского интерфейса,
- Страницу входа в систему,
- Страницу "Страница не найдена",
- Страницу "Проект не найден",
- Страницу поиска.
Это страницы, доступные для читателей – анонимных пользователей и авторизованных читателей.

Пользовательский домен

Когда вы подпишитесь на пробную версию, URL вашего портала будет выглядеть следующим образом https://yourportal.clickhelp.co. Но вы можете установить пользовательское доменное имя. Чтобы изменить доменное имя портала по умолчанию на пользовательское, следуйте инструкциям из следующей статьи: Пользовательское доменное имя для портала.

Домашняя страница портала

Домашняя страница портала – это то, что видят пользователи, когда переходят по корневому URL портала документации, например, http://doc.clickhelp.com.

Давайте рассмотрим стандартный вид страницы и поговорим о ее элементах.

Читательское меню. Оно не является частью домашней страницы, так как создается из выбранного шаблона читательского интерфейса. Его стили одинаковы для всего портала. Вы можете настроить содержимое читательского меню с помощью Редактора читательского меню как описано на странице Редактор читательского меню. Кроме того, вы можете стилизовать его с помощью CSS-файла для глобального брендинга. Логотип заголовка настраивается в разделе настроек портала Логотип заголовка.

Содержание домашней страницы. Вы можете настроить стили и наполнение домашней страницы в разделе Настройки домашней страницы портала. Также вы можете изменить фоновое изображение по умолчанию.

	Примечание
Вы можете полностью заменить весь HTML-контент домашней страницы с помощью пользовательской разметки. Посмотрите примеры пользовательских дизайнов домашних страниц наших клиентов в разделе Галерея портала.

Динамически генерируемый список публикаций. Отображает список публикаций, доступных для текущего читателя, где дизайн каждого элемента зависит от шаблона разметки ссылок на публикации. Этот список может различаться для анонимных и авторизованных читателей в зависимости от их прав доступа. Подробнее о настройке этого элемента вы можете узнать на странице Домашняя страница портала → Синтаксис временного текста.

	Примечание
Заголовок домашней страницы является SEO-элементом.

Читательский интерфейс

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

Публикация в пользовательском интерфейсе читателя

Читательский интерфейс. Он стилизован с помощью брендинговых CSS. В системе предусмотрено шесть предопределенных шаблонов читательского интерфейса; вы можете переключаться между ними в разделе Читательский интерфейс в настройках портала. Кроме того, наша команда по брендингу может создать индивидуальный шаблон читательского интерфейса по вашему желанию!
Контент на странице. Авторы оформляют его с помощью встроенных стилей (применимы к определенным элементам на странице) или более централизованно с помощью файлов стилей проекта. Чтобы узнать больше о стилизации страниц, см. Стилизация контента страницы.

Оглавление также является частью читательского интерфейса. Подробнее о его настройке вы можете прочитать здесь: Настройка оглавления.

Вы можете ознакомиться с различными примерами брендинга читательского интерфейса в нашей Галерее портала.

В Документерре вы можете быстро адаптировать внешний вид портала онлайн-документации к стилю вашей компании. Далее в этом разделе вы сможете больше узнать о том, как изменять стили.

Использование платных шрифтов Домашняя страница портала