Skip to content

2023-11-20

MkDocs の拡張機能

一瞬混乱したので整理。

拡張機能(Extensions)

  • markdown 記法の表現を拡張するためのもの
    • ハイライト、コードブロックなど
  • サードパーティ製のものは必要に応じて pip でインストール
  • mkdocs.yml 内に以下のように書く
    markdown_extensions:
        - hogehoge
    

拡張機能一覧

プリセット

サードパーティ製

プラグイン(Plugins)

  • MkDocs で生成するページ内での機能拡張を行うためのもの
    • 検索機能、タグクラウド機能など
  • サードパーティ製のものは必要に応じて pip でインストール
  • mkdocs.yml 内に以下のように書く
    plugins:
        - hogehoge
    

プラグイン一覧

プリセット

サードパーティ製

よくわからんがたくさんあるっぽい。
必要になったら GitHub で探す。

干し芋

  • コードハイライトがきれいになるやつ
  • 表がなんかいい感じになるやつ
  • mermaid をもうちょっと調整する
  • ブログ機能を拡充するやついろいろ