Deutsch
Über dieses Handbuch

Dieses Handbuch gehört zum Quartz-Plugin quartz-layout-box. Und es ist mit ihm gebaut: Diese Box hier ist eine Layout-Box.

Sie kommt aus einer Markdown-Datei, nicht aus der Konfiguration — welcher Weg wann der bessere ist, steht in Der Schnipsel.

1.2 – Die erste Box

Vier Schritte, und die Box steht.

1. Plugin installieren

npx quartz plugin add github:boxi-os/quartz-layout-box

Der Befehl holt das Plugin und trägt es in die quartz.config.yaml ein. In QuartzControl geht dasselbe über den Marktplatz.

2. Schnipsel anlegen

Die Datei kommt nach quartz/static/snippets/ — der Ordner gehört zur Site, nicht zum Inhalt. Er wird bei Bedarf angelegt:

<!-- quartz/static/snippets/snippet.html -->
<p>Notizen aus einer kleinen Stadt.</p>

3. Eintragen

plugins:
  - source: github:boxi-os/quartz-layout-box
    enabled: true
    options:
      file: snippet.html
    layout:
      position: left
      priority: 15

position sagt wohin, priority in welcher Reihenfolge innerhalb dieser Stelle — kleiner heißt weiter oben. Beides erklärt Kapitel 3.

Ohne options geht es auch

Dann gilt die Grundeinstellung: die Datei snippet.html im Ordner quartz/static/snippets.

4. Ansehen

npx quartz build --serve

Die Box steht in der linken Spalte. Ändert man jetzt die Schnipsel-Datei, genügt ein Neuladen — kein Neustart des Servers. Warum das ohne Beobachter funktioniert, steht unter 1.3 – Was beim Bauen passiert.

Wenn nichts erscheint

Was zu sehen istWoran es liegt
Eine gestrichelte Box mit einem PfadDie Datei fehlt an genau dieser Stelle. Die gestrichelte Box erscheint nur im Serve-Modus; im normalen Bau bleibt die Box leer und die Konsole sagt es einmal.
Gar nichts, keine MeldungDas Schnipsel ist leer. Eine Box ohne Inhalt gibt nichts aus — auch kein leeres div.
Gar nichts, aber eine Warnung im BauDer Pfad führt aus dir hinaus. Das lehnt das Plugin ab; siehe 2.2 – Woher die Datei kommt.
Die Box steht, aber an der falschen Stelleposition oder priority — 3.2 – Die Reihenfolge.