Snippets

Mit der Snippet-Komponente können Sie Inhalte in Ihrer gesamten Dokumentation wiederverwenden. Ein Snippet ist ein Inhaltsabschnitt, der in ein oder mehrere Themen eingefügt werden kann. Wenn Sie Änderungen am Snippet vornehmen, werden diese überall dort übernommen, wo das Snippet verwendet wird. Dies kann insbesondere bei Standardtexten nützlich sein. Snippets verfügen im CMS über eine eigene Sammlung und sind in einem separaten Bereich des Repositorys gespeichert.

1. Wählen Sie die Snippet-Komponente aus der Liste Einbetten aus.
2. Bearbeiten Sie die Komponente.
3. Wählen Sie eine Datei aus der Liste aus. Die Liste wird bei jedem Start des Entwicklungsservers oder bei jedem Build mit allen Dateien aus dem Ordner /reuse/snippets/ gefüllt.

Ein Snippet wird bereits beim Erstellen der Website Teil des Themas und nicht erst beim Laden der Seite abgerufen. Daraus ergeben sich drei Konsequenzen:

• Die Website-Suche findet den Text eines Snippets unter jedem Thema, in dem er verwendet wird.
• Überschriften innerhalb eines Snippets erscheinen im Inhaltsverzeichnis des Themas.
• Ein Snippet kann ein anderes Snippet enthalten.

Hinweis

Ein Snippet, das auf eine Datei verweist, die nicht mehr existiert, gibt dies direkt an, so wie es auch ein Glossarbegriff oder eine Variable tut:

missing-file.mdx NOT FOUND

Der Build-Vorgang wird dennoch erfolgreich abgeschlossen, sodass ein falscher Dateiname Sie nicht daran hindert, eine Vorschau der Website anzuzeigen. Der Build listet diese Dateien zudem auf, falls es sich um ein Thema handelt, das Sie gerade nicht im Blick hatten.

Beispiel

Snippets-Beispiel

Dies ist ein Inhalt aus example.mdx.