Branding

​

Nagłówek

W tej sekcji opisujemy, jak spersonalizować kluczowe elementy Twojej instancji on-premises. Możesz dostosować tytuł witryny, linki nawigacyjne, nagłówek, stopkę i logo zgodnie z własnymi preferencjami.

​

Tytuł witryny

Tytuł paska nawigacyjnego można dostosować za pomocą zmiennej środowiskowej OVERLEAF_NAV_TITLE. Ten tekst jest wyświetlany w lewym górnym rogu nawigacji, jeśli nie ustawiono logo.

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

​

Logo

Zamiast tekstu możesz dodać własne logo, ustawiając zmienną środowiskową OVERLEAF_HEADER_IMAGE_URL. Jej wartość powinna wskazywać na plik graficzny hostowany zewnętrznie.

config/variables.env

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

​

Logo dla motywu jasnego i ciemnego

Od wersji 6.3.0 możesz ustawić osobne logo dla motywu jasnego i ciemnego za pomocą zmiennych środowiskowych OVERLEAF_HEADER_IMAGE_URL_LIGHT i OVERLEAF_HEADER_IMAGE_URL_DARK. Obie wartości powinny wskazywać na pliki graficzne hostowane zewnętrznie.

# 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

Jeśli któraś ze zmiennych nie jest ustawiona, dany motyw używa logo ustawionego w OVERLEAF_HEADER_IMAGE_URL.

​

Linki nawigacyjne w nagłówku

Dodatkowe elementy nawigacji można dodać do nagłówka, ustawiając zmienną środowiskową OVERLEAF_HEADER_EXTRAS na tablicę obiektów JSON. Na przykład:

[\
  {\
    "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"\
      }\
    ]\
  }\
]

Dodaj postać JSON ze zmienionymi znakami specjalnymi do 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"}]}]

​

Stopki

Można dostosować zarówno lewą, jak i mniejszą prawą stopkę (widoczne na stronach takich jak /project) za pomocą zmiennych środowiskowych OVERLEAF_LEFT_FOOTER i OVERLEAF_RIGHT_FOOTER. Obie oczekują tablicy obiektów JSON, które zostaną wstawione.

Obie oczekują tablicy JSON, która zostanie wstawiona.

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

Gdy używasz wyłącznie text, wartość nie może zawierać HTML, ponieważ zostanie wyświetlona jako surowy tekst.

Aby wszystko działało, dane muszą być poprawnym JSON-em, a cudzysłowy muszą być poprzedzone znakiem ucieczki, gdy są przekazywane jako zmienna środowiskowa.

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"]

Oprócz text i url obiekt JSON akceptuje również właściwości class i label, które pozwalają na dodatkowe dostosowanie.

​

Strona konserwacji

Komunikat wyświetlany na stronie konserwacji możesz dostosować za pomocą zmiennej środowiskowej OVERLEAF_MAINTENANCE_MESSAGE. Ten tekst zastępuje domyślny komunikat pod tytułem strony.

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

Aby dodać linki lub inne formatowanie, użyj zamiast tego OVERLEAF_MAINTENANCE_MESSAGE_HTML. Jeśli ustawione są obie zmienne, pierwszeństwo ma 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 jest wyświetlany jako zwykły tekst, więc nie może zawierać HTML. OVERLEAF_MAINTENANCE_MESSAGE_HTML jest renderowany jako HTML bez zmiany znaków specjalnych.

Jeśli żadna z nich nie jest ustawiona, domyślny komunikat zawiera link do Twojej strony statusu, gdy ustawiono OVERLEAF_STATUS_PAGE_URL, a w przeciwnym razie wyświetla adres e-mail administratora.