MKDocsでのコードブロックの書き方 - 気ままに技術勉強ブログ

はじめに

MKDocsでドキュメントを作成中、コードブロックの書き方で少し気になったことがあったため、自分への備忘録として記事にしました。

コードブロックの書き方には2種類あるそうです。

これはMKDocs以外でもよく見かけるコードブロックの書き方です。

バッククオート(`)を使用して以下のように書きます

ここはコードブロックです。

さて、この書き方はインデントできず、リスト項目、引用符などの内部にネストすることはできないことに注意してください。

この書き方は私は全く知りませんでした。

MKDocsだけなのか、他でもそのような書き方ができるかは定かではありませんが、インデントでコードブロックを表現できるようです。

頭にインデントを4つ入った場所をコードブロックとして認識するようで、インデントがなくなったらそこがコードブロックの終わりと認識するようです。

ここはコードブロックではありません
    ここはコードブロックです
    ここはコードブロックです
ここはコードブロックではありません

MKDocsで使える２種類のコードブロックの書き方を見てきました。