Snippets
Snippet コンポーネントを使用すると、ドキュメント全体でコンテンツを再利用できます。スニペットは、1つ以上のトピックに挿入できるコンテンツのかたまりです。スニペットを変更すると、スニペットが使用されているすべての箇所に変更が反映されます。これは定型文に特に便利です。スニペットはCMSに専用のコレクションがあり、リポジトリの専用セクションに格納されています。
- 埋め込み リストから Snippet コンポーネントを選択します。
- コンポーネントを編集します。
- リストからファイルを選択します。リストは、開発サーバーを起動またはビルドを実行するたびに、
/reuse/snippets/フォルダー内のすべてのファイルで更新されます。
スニペットは、ページが読み込まれる際に取得されるのではなく、サイトの構築時にトピックの一部となります。このことから、次の3つのことが言えます：
- サイト内検索では、スニペットのテキストが、それを使用しているすべてのトピックの下で表示されます。
- スニペット内の見出しは、そのトピックの目次に表示されます。
- スニペットには、別のスニペットを含めることができます。
注記
存在しなくなったファイルを指すスニペットは、用語集の用語や変数と同様に、その場でその旨を示します：
missing-file.mdx NOT FOUND
ビルドは依然として成功するため、ファイル名が1つ間違っていてもサイトのプレビューは可能です。また、そのトピックを特に確認していなかった場合でも、ビルド結果にそれらのファイルが一覧表示されます。
例
スニペットの例
これは example.mdx のコンテンツです。