0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

MkDocsの箇条書きや番号付きリストのインデントをスペース2つに変更する方法

Posted at

デフォルトの挙動

既存のマークダウンが正しく動作しないと思い、色々試していたらmkdocsでは箇条書きや番号付きのリストには半角スペース4つ必要とのことです。

スペース2つにする方法

Python-Markdown 拡張のmdx_truly_sane_listsをインストール

pip install mdx_truly_sane_lists

mkdocs.ymlに設定を追加

markdown_extensions:
    - mdx_truly_sane_lists:
        nested_indent: 2

なぜスペース4つ?

結果から言うと、今更ですが、マークダウンの構文規則には「4つのスペースまたは1つのタブ」が正しいようです。

mkdocsは内部的にはPython Markdownを利用しているため、そっちのプロジェクトのトップページを確認したところIndentation/Tab Lengthに説明が書いてありました。
そこの説明にはtab_lengthで2つにすることもできる感じですが、mkdocsに該当のオプション無いですね・・・

新たなる問題

私はPDFも作るのでmkdocs-with-pdfも利用していたのですが、そっちでは箇条書きのリストが正しく表示されないので、別途調べてみます。

image.png

参考URL

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?