Lantanaでは、mkdocs.ymlを使ってサイト全体の設定を変更できます。

サイト名

サイトの名前を指定します。これは、サイト上部に表示されるほか、ページのタイトルにも含まれます。

site_name: サイト名

ヘッダー名

サイトのヘッダーに表示される名前を指定します。これは、サイト名よりも優先的にサイト上部に表示されます。

header_name : ヘッダー名

著作権表示

サイトの著作権表示を指定します。これは、サイト下部に表示されます。

copyright : 'Copyright © 2022 ME All Rights Reserved.'

ドキュメントディレクトリ

記事が保存されているディレクトリを指定します。

docs_dir : 'docs'

JavaScript

サイトの各ページに挿入されるJavaScriptを指定します。

extra_javascript:
  - 'main.js'

スタイルシート

サイトの各ページに挿入されるスタイルシートを指定します。

extra_stylesheet:
  - 'main.js'

ファビコン

サイトのアイコンです。これは、サイト上部に表示されるほか、サイトのファビコンにも使用されます。

logo : logo.png

Svg形式のファビコン

Svc形式のファビコンです。これは、サイトのファビコンに使用されます。

logo_svg : logo.svg

フッターアイコン

サイトのサブアイコンです。これは、サイト下部に表示されます。

footimg : logo.svg

サイトの画像

サイトの画像です。これは、記事に指定された画像が存在しないときに使用されます。

image : thumbnail.png

サイトの言語

サイトの言語です。これは、ページの言語としてブラウザに伝えられます。

language : ja

テーマ

MKDocsのテーマです。これをlantanaに指定することでLantanaが有効になります。

theme : lantana

プラグイン

MKDocsで使用するプラグインです。

plugins:
    - search:

検索の言語

サイト内検索で使用される言語を指定します。この項目で'ja'を指定することで、サイト内検索で日本語を検索可能になります。

plugins:
    - search:
        lang : 'ja'

マークダウン拡張

記事内で使用できるマークダウンの拡張機能です。Lantanaのコードハイライトなどの機能はこれを用いて実装されています。

markdown_extensions:
    # コードハイライトの設定
    - codehilite
    # アラート修飾の設定
    - admonition
    # スーパーフェンス機能の設定
    - pymdownx.superfences
    # コンテンツの折りたたみ
    - pymdownx.details

ヘッダーを非表示

サイトのヘッダーを非表示にするかどうかの値です。

disable_header : false

印刷時にヘッダーを非表示

対応バージョン:=2.8

サイトのヘッダーを印刷時に非表示にするかどうかの値です。

disable_header_when_printing : true

フッターを非表示

サイトのフッターを非表示にするかどうかの値です。

disable_footer : false