コンテンツへスキップ
Fumadocs

Remark Show

条件に応じてコンテンツを表示します。

使い方

Remark Show は、<show> 構文を扱う remark プラグインです。Fumadocs MDX、@fumadocs/astro、ローカル Markdown では、デフォルトで有効になっています。

<show> は、when の式が true の場合に内容をレンダリングします。式はページのレンダリング時に評価されるため、パスパラメーターなどのページの props を参照できます。when を指定していない <show> はコンパイルエラーになります。

ページデータ

レンダリングされないコンテンツは、ページデータからも除外されます。対象となるのは、目次、見出しID、構造化データ、処理済みのMarkdownです。

これらのデータは、Rehype TOC、Remark Structure、Remark LLMsが生成します。Fumadocs MDXを使用しない場合、 これらは条件を評価できるより前のコンパイル時にデータを生成するため、<show>を含むドキュメントはコンパイルに失敗します。 カスタムのコンテンツソースでは、ランタイム出力を有効にしてください。

ステップとタブグループ

<show> では、ステップやタブグループのコードブロックをラップできます。例を参照してください。

  • プラグインの配列では、Remark Show を Remark Steps と remarkCodeTab よりも前に追加してください。
  • 少なくとも 1 つのステップまたはタブを <show> の外側に残してください。そうしないと、<show> ごとに別々のステップやタブグループが生成されます。

How is this guide?

最終更新日