コンテンツにスキップ

MkDocs

MkDocsは静的サイトジェネレータです。コンテンツは基本的にmarkdown形式で記述したソースファイルになります。

Note

本記事は特記事項がない限り、Material for MkDocsのテーマ内容を記載します。

使い方

詳細は下記を確認してください。

設定関連

コンテンツの各種設定はmkdocs.ymlに記述します。

ドキュメント構成

表示

マクロ関連

MkDocs Macros Pluginを使用して、Gistのコードブロックを生成するマクロについて

MkDocs Macros Pluginを使用して、カスタムリンクカードマクロを作成するマクロについて

MkDocs Macros Pluginを使用して、X(旧Twitter)のリンクカードを表示するマクロについて

Reference

以下の記事を参考にさせていただいています。