Materialテーマを使ってみよう

ここでは、外部テーマの1つである Material テーマを使う設定を行います。すごく便利なので、自作する気がなくなってしまうほどです。

Materialテーマのインストール

外部テーマをインストールする方法はテーマによって異なります。Material テーマは、次のように pip を使います。

> pip install mkdocs-material

しばらくするとインストールが終わります。次に、このテーマを使えるように設定します。mkdocs.yml に、次のように書きます。

theme:
    name: material

これで、Material テーマが使えるようになります。かっこいいデザインになりました。

もし、pip を使いたくない場合は、GitHub からダウンロードし、以下のように設定することでも使えます。

theme:
    name: null
    custom_dir: mkdocs-material/material

まず、サイトを日本語化しましょう。

theme: 
    name: material
    language: 'ja'

こうすると、例えば、Prev や Next といった単語が「次」「前」に変わったり、Search が「検索」に変わったりします。

また、検索機能はあるものの、何も設定しなければ、日本語の検索はできません。日本語にも対応するには、次の記載も追加します。

extra:
    search:
        language: 'jp'

ただ、完全に検索できるわけではなさそうです。結構、モレがあります。

他にも、色の設定やフォントなど、いろいろな項目を設定できます。

ここでは、Materialテーマのインストールと、便利な設定を見てきました。次は、記事を書くときなどで使える、便利な機能について見ていくことにします。