ブランディング

​

ヘッダー

このセクションでは、オンプレミスインスタンスの主要な要素をカスタマイズする方法を説明します。サイトタイトル、ナビゲーションリンク、ヘッダー、フッター、ロゴを好みに合わせてカスタマイズできます。

​

サイトタイトル

ナビゲーションバーのタイトルは環境変数 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"}]}]

​

フッター

環境変数 OVERLEAF_LEFT_FOOTER と OVERLEAF_RIGHT_FOOTER を使うと、左側のフッターと小さめの右側のフッター（/project などのページに表示されます）の両方をカスタマイズできます。どちらも挿入される 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"]

JSON オブジェクトは text と url に加えて、追加のカスタマイズ用に 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 が設定されていればステータスページへのリンクを表示し、設定されていなければ管理者のメールアドレスを表示します。