ブランディング

ヘッダー

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

サイトタイトル

ナビゲーションバーのタイトルは次の OVERLEAF_NAV_TITLE 環境変数でカスタマイズできます。このテキストはロゴが設定されていない場合、ナビゲーションの左上に使用されます。

# config/variables.env に追加
OVERLEAF_NAV_TITLE=Our Overleaf Instance

ロゴ

テキストの代わりにカスタムロゴを追加するには、環境変数を設定します OVERLEAF_HEADER_IMAGE_URL。この値は外部ホストされた画像ファイルを指す必要があります。

config/variables.env に追加:

config/variables.env

# config/variables.env に追加
OVERLEAF_HEADER_IMAGE_URL=https://mysite.somewhere.com/img/logo.png

ヘッダーのナビゲーションリンク

追加のナビゲーション項目は、次の環境変数を設定することでナビゲーションヘッダーに追加できます。 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

# 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 のようなページにある）をそれぞれカスタマイズすることが可能です。 /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

# 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 追加のカスタマイズのために。