MetaTables拡張機能

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

taiseiue | 2024-07-12

対応バージョン:>=2.10

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

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

エスケープ解除

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

index.md

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

**例1**

=!\"extensions"\|[note]!=

**例2**

=!\"extensions"\|[note,include_subdir]!=

この時、記事には以下のメタデータを設定しておく必要があります。

メタデータ

mt_type: タイプ

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

オプション	説明
`include-index`	ディレクトリ内の`index.md`ファイルを一覧に含めます
`include-subdir`	ディレクトリ内のサブディレクトリの`index.md`ファイルを一覧に含めます
`style-lite`	一覧を表形式ではなく箇条書きとして出力します
`smart-jump`	リンクを`title`で指定された要素にジャンプするように構成します

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

mkdocs.yml

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