カスタムスニペットの作成
snippets
ディレクトリ内にスニペットファイルを作成する必要があります。
snippets
ディレクトリ内の任意のページはスニペットとして扱われ、スタンドアロンのページとしては
レンダリングされません。スニペットからスタンドアロンのページを作成したい場合は、
そのスニペットを別のファイルにインポートし、コンポーネントとして呼び出してください。
デフォルトエクスポート
- 再利用したいコンテンツをスニペットファイルに追加します。必要に応じて、スニペットをインポートする際に props で埋め込める変数を追加できます。 この例では、変数は word です。
snippets/my-snippet.mdx
- スニペットを使用先のファイルにインポートします。
destination-file.mdx
変数を使ったエクスポート
- 必要に応じて、スニペットをインポートする際に props で埋め込める変数を追加できます。この例では、変数は word です。
snippets/my-snippet.mdx
- 変数を指定してスニペットを出力先ファイルにインポートします。プロパティは指定どおりに埋め込まれます。
destination-file.mdx
再利用可能な変数
- スニペットファイルから変数をエクスポートします:
snippets/path/to/custom-variables.mdx
- 宛先ファイルでスニペットをインポートし、変数を使用します:
destination-file.mdx
JSX スニペット
- スニペットファイルから JSX コンポーネントをエクスポートします(詳細は React components を参照):
snippets/my-jsx-snippet.jsx
重要: JSX スニペットを作成する際は、関数宣言ではなくアロー関数構文(
=>
)を使用してください。このコンテキストでは function
キーワードはサポートされていません。- 使用先のファイルでスニペットをインポートし、コンポーネントを使用します:
destination-file.mdx