Брендинг

​

Заголовок

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

​

Название сайта

Название в панели навигации можно изменить с помощью переменной окружения OVERLEAF_NAV_TITLE. Этот текст отображается в левом верхнем углу панели навигации, если логотип не задан.

# add to config/variables.env
OVERLEAF_NAV_TITLE=Our Overleaf Instance

​

Логотип

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

config/variables.env

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL=https://mysite.somewhere.com/img/logo.png

​

Логотипы для светлой и тёмной темы

Начиная с версии 6.3.0, можно задать отдельные логотипы для светлой и тёмной темы с помощью переменных окружения OVERLEAF_HEADER_IMAGE_URL_LIGHT и OVERLEAF_HEADER_IMAGE_URL_DARK. Оба значения должны указывать на файл изображения, размещённый на внешнем ресурсе.

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL_LIGHT=https://mysite.somewhere.com/img/logo-light.png
OVERLEAF_HEADER_IMAGE_URL_DARK=https://mysite.somewhere.com/img/logo-dark.png

Если какая-либо из переменных не задана, для соответствующей темы используется логотип, указанный в OVERLEAF_HEADER_IMAGE_URL.

​

Навигационные ссылки в заголовке

Дополнительные пункты навигации можно добавить в заголовок, задав переменной окружения OVERLEAF_HEADER_EXTRAS значение в виде JSON-массива объектов. Например:

[\
  {\
    "text": "Some link",\
    "url": "http://example.com/somelink",\
    "class": "subdued",\
    "only_when_logged_out": true\
  },\
  {\
    "text": "Help",\
    "class": "subdued",\
    "dropdown": [\
      {\
        "text": "Documentation",\
        "url": "/learn"\
      },\
      {\
        "text": "Contact Admin",\
        "url": "http://example.com/contact"\
      }\
    ]\
  }\
]

Добавьте экранированную форму JSON в toolkit/variables.env:

toolkit/variables.env

# add to toolkit/variables.env
OVERLEAF_HEADER_EXTRAS=[{"text":"Some link","url":"http://example.com/somelink","class":"subdued","only_when_logged_out":true},{"text":"Help","class":"subdued","dropdown":[{"text":"Documentation","url":"/learn"},{"text":"Contact Admin","url":"http://example.com/contact"}]}]

​

Нижние колонтитулы

Можно настроить как левый, так и меньший правый нижний колонтитул (отображаются на страницах вроде /project) с помощью переменных окружения OVERLEAF_LEFT_FOOTER и OVERLEAF_RIGHT_FOOTER. Обе переменные ожидают массив JSON-объектов, которые будут вставлены.

Обе ожидают массив JSON, который будет вставлен.

[\
  {\
    "text": "This is an example text footer entry!"\
  },\
  {\
    "text": "This is an example URL footer link!", "url" : "/my-first-link.htm"\
  }\
]

Если используется только text, он не должен содержать HTML, так как значение будет выведено как обычный текст.

Для корректной работы эти данные должны быть валидным JSON, а кавычки при передаче через переменную окружения должны быть экранированы.

config/variables.env

# add to config/variables.env
OVERLEAF_LEFT_FOOTER=[{"text": "This is an example text footer entry!"}]
OVERLEAF_RIGHT_FOOTER=["text": "This is an example URL footer link!", "url" : "/my-first-link.htm"]

Помимо text и url, JSON-объект также принимает свойства class и label для дополнительной настройки.

​

Страница технического обслуживания

Сообщение на странице технического обслуживания можно изменить с помощью переменной окружения OVERLEAF_MAINTENANCE_MESSAGE. Этот текст заменяет стандартное сообщение под заголовком страницы.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE=Our Overleaf Instance is down for maintenance and will be back shortly.

Чтобы добавить ссылки или другое форматирование, используйте вместо неё OVERLEAF_MAINTENANCE_MESSAGE_HTML. Если заданы обе переменные, приоритет имеет OVERLEAF_MAINTENANCE_MESSAGE_HTML.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE_HTML=Our Overleaf Instance is down for maintenance. For urgent requests, contact <a href="mailto:[e-mail]">[e-mail]</a>.

OVERLEAF_MAINTENANCE_MESSAGE выводится как обычный текст, поэтому он не должен содержать HTML. OVERLEAF_MAINTENANCE_MESSAGE_HTML выводится как HTML без экранирования.

Если ни одна из переменных не задана, стандартное сообщение содержит ссылку на вашу страницу статуса, когда задана OVERLEAF_STATUS_PAGE_URL, а в противном случае показывает адрес электронной почты администратора.