MkDocs の設定いろいろ

MkDocs の細かい設定いろいろです。 必要に応じて適宜更新していきたいと思います。 ## URL を自動でハイパーリンクする 以下の拡張機能を有効にします。 ```yml markdown_extensions: - pymdownx.magiclink ``` ## Material for MkDocsで打ち消し線が動作するようにする 以下の拡張機能を有効にします。 ```yml markdown_extensions: - pymdownx.tilde ``` ## スペース2個でリストがインデントされるようにする デフォルトではスペース4個でないとリストがインデントされません。 これをスペース2個でもインデントされるようにするには、`mdx_truly_sane_lists` という拡張機能をインストールします。 ```shell $ pip install mdx_truly_sane_lists ``` mkdocs.yml に以下を追記します。 ```yml markdown_extensions: - mdx_truly_sane_lists: nested_indent: 2 ``` ## 更新日時を表示する ```shell $ pip install mkdocs-git-revision-date-localized-plugin ``` ```yml plugins: - search - git-revision-date-localized ``` Material for MkDocs を使っている場合はこれだけで全ページの下部に更新日時が表示されるようになります。 オプション設定で書式などを変更することもできるようです。 - https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/ ## 参考 URL - https://github.com/mkdocs/mkdocs/issues/1711 - https://kurotori4423.github.io/KurotoriMkDoc/MkDocs%E8%A7%A3%E8%AA%AC/Extension/ - https://stakiran.hatenablog.com/entry/2018/08/02/202816 - https://roy-n-roy.nyan-co.page/mkdocs/gitRevisionDate/