MkDocs拡張機能

MkDocsは拡張機能（Extension）を有効にすることによって、様々な機能を追加することができる。

公式サポート拡張（Officially Supported Extensions）

公式でサポートされている拡張機能。MkDocsに最初から含まれており、追加インストールしなくても使用することができる。

mkdocs.yml内でmarkdown_extensions:に拡張機能の名前を追加する。

例：Attribute Listsの場合

1
2
3

markdown_extensions:
    - attr_list
    - 拡張機能名

生成されるHTMLの要素に任意の属性を追加することができる拡張機能。例えば見出しに対してid属性を指定したい場合次のように書く

1	### カスタムクエリ {: #Custom-queries}

すると以下のようなHTMLが生成される

1	<h3 id="Custom-queries">カスタムクエリ</h3>

extra_cssに以下のタグを追加する

.center {
  display: block; /*ブロック要素にする*/
  margin: 0 auto; /*中心揃え*/
}

画像を中心揃えで挿入する

1	![image](image.png){: .center}

コードをハイライトする。300言語対応している。
https://squidfunk.github.io/mkdocs-material/extensions/codehilite/

1	pip install pygments

mkdocs.ymlに以下を追加

1 2	markdown_extensions: - codehilite

行番号を追加する場合

1
2
3

markdown_extensions:
    - codehilite:
        linenums: true

1	pip install houdini-lexers

でインストールする。コードブロックでvexを指定することによってvexのハイライトが可能。

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

1 2	markdown_extensions: - pymdownx.tilde

その他、PyMdown Extensionsの拡張機能一覧