options
| Option | Typ | Vorgabe | Bedeutung |
|---|---|---|---|
file | Text | snippet.html | Datei innerhalb von dir. Endung .md wird als Markdown gerendert. Ohne Wirkung, wenn html gesetzt ist. |
dir | Text | quartz/static/snippets | Ordner der Schnipsel, ab der Wurzel der Site. Pfade darüber hinaus werden abgelehnt. |
html | Text | – | Markup direkt in der Konfiguration. Hat Vorrang vor file. |
className | Text | – | Zusätzliche Klasse(n) neben layout-box. |
title | Text | – | Überschrift als h3. Platzhalter erlaubt. |
collapsible | Ja/Nein | false | Als details rendern, title wird die Klickzeile. Braucht title. |
collapsed | Ja/Nein | false | Zugeklappt beginnen. Nur mit collapsible. |
placeholders | Ja/Nein | true | {{…}} ersetzen. |
frontmatterKey | Text | layoutBox | Feld, über das eine Seite die Box steuert. |
byLang | Objekt | – | Abweichende Optionen je Sprache. dir und frontmatterKey sind nicht vorgesehen ([[7-zwei-sprachen/01-bylang |
Erklärt werden sie in Kapitel 2 (Quelle), 4
(Platzhalter), 5 (Form), 6 (Frontmatter) und
7 (byLang).
layout
Gehört Quartz, nicht dem Plugin — dieselben Werte wie bei jeder Komponente.
| Feld | Werte | Bedeutung |
|---|---|---|
position | header, left, right, beforeBody, afterBody, footer | Wo die Box steht |
priority | Zahl, Vorgabe 15 | Reihenfolge an dieser Stelle, kleiner ist weiter oben |
display | all, desktop-only, mobile-only | Auf welchen Breiten sie erscheint |
group | Text | Mehrere Komponenten nebeneinander statt untereinander |
Frontmatter
| Schreibweise | Wirkung |
|---|---|
<key>: false | Box auf dieser Seite ausblenden |
<key>: datei.html | anderes Schnipsel |
<key>: { hidden, file, html, title, collapsible, collapsed } | einzelne Optionen für diese Seite |
Klassen im erzeugten Markup
| Klasse | Wo |
|---|---|
layout-box | am äußeren Element, immer |
layout-box-title | an der Überschrift, nur mit title |
layout-box-content | am inneren div mit dem Schnipsel |
layout-box-missing | an der gestrichelten Box, nur im Serve-Modus |