Branding

​

Header

Di bagian ini, kami akan membahas cara mempersonalisasi elemen-elemen utama dari instans on-premises Anda. Anda dapat menyesuaikan judul situs, tautan navigasi, header, footer, dan logo sesuai preferensi Anda.

​

Judul situs

Judul bilah navigasi dapat disesuaikan dengan variabel lingkungan OVERLEAF_NAV_TITLE. Teks ini digunakan di pojok kiri atas navigasi jika tidak ada logo yang diatur.

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

​

Logo

Anda dapat menambahkan logo kustom alih-alih menggunakan teks dengan mengatur variabel lingkungan OVERLEAF_HEADER_IMAGE_URL. Nilai ini harus mengarah ke file gambar yang di-host secara eksternal.

config/variables.env

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

​

Logo tema terang dan gelap

Mulai versi 6.3.0, Anda dapat mengatur logo terpisah untuk tema terang dan gelap dengan variabel lingkungan OVERLEAF_HEADER_IMAGE_URL_LIGHT dan OVERLEAF_HEADER_IMAGE_URL_DARK. Kedua nilai harus mengarah ke file gambar yang di-host secara eksternal.

# 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

Jika salah satu variabel tidak diatur, tema tersebut akan menggunakan logo yang diatur di OVERLEAF_HEADER_IMAGE_URL sebagai cadangan.

​

Tautan navigasi header

Item navigasi tambahan dapat ditambahkan ke header navigasi dengan mengatur variabel lingkungan OVERLEAF_HEADER_EXTRAS ke array objek JSON. Contohnya:

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

Tambahkan bentuk JSON yang telah di-escape ke 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"}]}]

​

Footer

Anda dapat menyesuaikan footer kiri maupun footer kanan yang lebih kecil (terdapat pada halaman seperti /project) menggunakan variabel lingkungan OVERLEAF_LEFT_FOOTER dan OVERLEAF_RIGHT_FOOTER. Keduanya mengharapkan array objek JSON yang akan disisipkan.

Keduanya mengharapkan array JSON yang akan disisipkan.

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

Saat hanya menggunakan text, nilainya tidak boleh berisi HTML karena nilai tersebut akan ditampilkan sebagai teks mentah.

Data ini harus berupa JSON yang valid agar berfungsi, dengan tanda kutip yang di-escape saat diteruskan sebagai variabel lingkungan.

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

Selain text dan url, objek JSON juga menerima properti class dan label untuk kustomisasi tambahan.

​

Halaman pemeliharaan

Anda dapat menyesuaikan pesan yang ditampilkan di halaman Pemeliharaan dengan variabel lingkungan OVERLEAF_MAINTENANCE_MESSAGE. Teks ini menggantikan pesan default di bawah judul halaman.

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

Untuk menyertakan tautan atau format lainnya, gunakan OVERLEAF_MAINTENANCE_MESSAGE_HTML sebagai gantinya. Jika keduanya diatur, OVERLEAF_MAINTENANCE_MESSAGE_HTML akan diprioritaskan.

# 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 ditampilkan sebagai teks biasa, sehingga tidak boleh berisi HTML. OVERLEAF_MAINTENANCE_MESSAGE_HTML ditampilkan sebagai HTML tanpa escaping.

Jika keduanya tidak diatur, pesan default akan menautkan ke halaman status Anda saat OVERLEAF_STATUS_PAGE_URL diatur, dan menampilkan alamat email admin jika tidak diatur.