Брендування

​

Заголовок

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

​

Назва сайту

Назву в панелі навігації можна змінити за допомогою змінної середовища 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, а якщо ні — показує адресу електронної пошти адміністратора.