MKDocsで頻繁に使いそうな設定

サイトをカスタマイズしたい時は、mkdocs.ymlファイルを編集します。

サイト名の変更

mkdocs.ymlの一番上にあるsite_nameで変更します

テーマの設定

テーマとは、サイトやブログをつくるときにデザインや機能を決める「テンプレート」のこと 以下のように記述します

theme: xxx

もしくは以下のような記述でも大丈夫です。

theme:
    name: xxx

テーマにはreadthedocsなど色々なものがあるそうです。

検索フォームの日本語対応

MkDocs 1.2 より Material 以外のテーマでも日本語検索に対応しているそうです。

theme内にて、以下のように設定してください

theme:
    name: xxx
    locale: ja

※themeが"mkdocs", "readthedocs"の場合の設定です(他の場合は違ったりします)

Copyrightの指定

以下の記述をすることで著作権情報に関する記載を載せることができます

copyright: 'Copyright © 20xx - 20xx - XXXX, Inc.'

おわりに

簡単ですが、頻繁に使いそうな基本の設定について調べてみました。

これ以外にもたくさんあり、くわしいことは以下を参考にしてみてください

www.mkdocs.org

また、テーマによっても設定可能なものが違うようなのでテーマに合わせて調べる必要もありそうです。 (materialでしか使えない設定っぽいのにどれにでも使えそうに書いてあり、調べていて頭が混乱しました、笑)