Cards拡張機能

この記事では、Cards拡張機能の使用方法について説明します

taiseiue | 2024-03-07

対応バージョン:>=2.9

Cards拡張機能は、Lantanaに指定ディレクトリの記事一覧を生成する拡張機能です。この拡張機能を有効化することで、以下のコンポーネントが使用できるようになります。

以下の構文で使用できます。ディレクトリ名はdocsディレクトリからの相対パスを使用します。

エスケープ解除

以下の例ではすべてエスケープのためのバックスラッシュ(\)が入っています。これは、この拡張機能がコードブロック中でも作用するためです。実際に使用する際はバックスラッシュ文字を削除してください。

index.md

=\"ディレクトリ名"|[オプション(カンマ区切り)]\=

**例1**

=\"extensions"\=

**例2**

=\"extensions"|[style-lite]\=

例1

例2

Cards構文中で使用できるオプションは以下の通りです。

オプション	説明
`include-index`	ディレクトリ内の`index.md`ファイルを一覧に含めます
`include-subdir`	ディレクトリ内のサブディレクトリの`index.md`ファイルを一覧に含めます
`style-lite`	一覧をカード形式ではなく箇条書きとして出力します

設定ファイル(mkdocs.yml)に以下の行を追加します。

mkdocs.yml

markdown_extensions:
      (中略)
    - lantana.cards
      (中略)