MkDocsのFooterをカスタマイズする
MkDocsを使っているとFooterを直接カスタマイズしたいと思うことがある。
具体的にはファイルを上書きする、という方法があるのでそれを述べる。
前提としてMaterial for MkDocsを使用しているものとする。
1. Material for MkDocsのダウンロード
MkDocsを上書きするために、上書き元となるファイルをダウンロードする。
まずはバージョンを確認。
$ pip list | grep mkdocs-material
mkdocs-material (4.0.1)
対象バージョンのMaterial for MkDocsを任意の場所にダウンロードする。
(たまたま最新だったので、最新のをダウンロード)
$ git clone https://github.com/squidfunk/mkdocs-material.git
2. ファイルの上書き設定
カスタムディレクトリを設定する。
カスタムディレクトリ、とはこのディレクトリ配下に置いたhtmlファイルが上書きされる、ということを意味するディレクトリである。
$ vi mkdocs.yml
theme:
custom_dir: 'custom_dir'
3. 上書きファイルを配置
MkDocs for Materialのボディに相当するファイルは以下にあるので、これをカスタムディレクトリ配下にコピーする。
$ cp ~/mkdocs-material/material/partials/footer.html ./custom_dir/partials/footer.html
以降、./custom_dir/partials/footer.htmlファイルを書き換えれば上書きされる。