プログラムを中心とした個人的なメモ用のブログです。 タイトルは迷走中。
内容の保証はできませんのであしからずご了承ください。

2022/06/03

MkDocs の設定いろいろ

update2022/07/15 event_note2022/06/02 23:27

MkDocs の細かい設定いろいろです。

必要に応じて適宜更新していきたいと思います。

URL を自動でハイパーリンクする

以下の拡張機能を有効にします。

markdown_extensions:
  - pymdownx.magiclink

Material for MkDocsで打ち消し線が動作するようにする

以下の拡張機能を有効にします。

markdown_extensions:
  - pymdownx.tilde

スペース2個でリストがインデントされるようにする

デフォルトではスペース4個でないとリストがインデントされません。
これをスペース2個でもインデントされるようにするには、mdx_truly_sane_lists という拡張機能をインストールします。

$ pip install mdx_truly_sane_lists

mkdocs.yml に以下を追記します。

markdown_extensions:
  - mdx_truly_sane_lists:
      nested_indent: 2

更新日時を表示する

$ pip install mkdocs-git-revision-date-localized-plugin
plugins:
  - search
  - git-revision-date-localized

Material for MkDocs を使っている場合はこれだけで全ページの下部に更新日時が表示されるようになります。
オプション設定で書式などを変更することもできるようです。