ディレクティブレジストリ

:::name / ::name / :name のディレクティブ構文を JSX コンポーネントへマッピングするコアのプリミティブ。

DirectiveRegistry は、CommonMark Directives 構文 — コンテナ（:::name）、 リーフ（::name[label]）、テキスト（:name[label]） — を、コンパイル済み 出力の JSX コンポーネント呼び出しにマッピングするコアのプリミティブです。

このプリミティブは Core に存在しますが、レジストリ visitor は通常のパイプラインにはデフォルトで追加されません。markdown.features.directives が指定されたとき、または Rust コードが DirectiveRegistry を手動で挿入したときだけ実行されます。次の 2 つの方法で利用できます:

• 設定から — オプトインの directives 機能を使って、Rust を書かずにディレクティブ名を登録する。directives: {} を指定しても、空のレジストリが配線されます。

• Rust から — DirectiveRegistry を直接構築してパイプラインに挿入する。 カスタムディレクティブ を参照。

ディレクティブの形状

レジストリは 3 つのディレクティブ形状を扱います:

• コンテナ — :::name[label] … ::: は、複数段落の本文を JSX コンポーネントで包む。

• リーフ — ::name[label]{attrs} は、子要素を持たない 自己終結型のコンポーネントを生成する。

• テキスト — :name[label]{attrs} はインラインコンポーネント。

デフォルトはゼロ

レジストリには、事前登録されたディレクティブ名は一つもありません。使用する すべての :::name は明示的に登録する必要があります — zfb.config.ts の directives 機能を介すか、Rust でレジストリを 構築するかのいずれかです。レジストリが有効なとき、認識されないディレクティブ名は警告診断を出力し、その元の段落を変更せずに残します。

型付きの属性スキーマ（#584 より）

レジストリは、登録された各ディレクティブに対して型付きの属性スキーマを 受け付けます。未知の属性はビルド時の 警告 を出力します（属性自体は 変更されずにそのまま通過します）。型強制の失敗（例えば Boolean 属性に 非ブール値を渡した場合）は、警告ではなく エラー を出力します。各属性は AttrSchema として宣言します。

AttrType には 4 つのバリアントがあります。

スキーマは register 呼び出しと並べて宣言します。

registry.register(
    DirectiveDef::text("badge", "Badge")
        .with_attrs(vec![
            AttrSchema { name: "tone".into(), ty: AttrType::String, default: None, required: false },
            AttrSchema {
                name: "size".into(),
                ty: AttrType::Enum(vec!["sm".into(), "md".into(), "lg".into()]),
                default: Some("md".into()),
                required: false,
            },
        ]),
);

カスタムディレクティブ

ディレクティブを追加で登録したり組み込みを上書きしたりするには、 カスタムディレクティブ を参照してください。 これは Rust を書く必要のない、著者向けの手段です。

関連項目

• directives 機能 — zfb.config.ts から レジストリに登録を行うオプトインの設定機能。

• カスタムディレクティブ — Rust API 経由で 新しい :::name／::name／:name のディレクティブ名を登録する。

• Markdown パイプラインを拡張する — エンジン側の拡張面。