Layout Box

quartz-layout-box setzt ein Stück HTML oder Markdown an eine beliebige Stelle des Quartz-Layouts: in eine Seitenspalte, in den Kopf, in die Fußzeile, vor oder nach den Seiteninhalt. Eine Wortmarke, ein Untertitel, ein Hinweis, ein Aufruf, eine Zeile mit dem Stand der Seite — alles, was auf vielen Seiten gleich aussehen soll, ohne dass man es in ein Theme schreibt.

Was es kann

An jeder Stelle der Seite

Kopf, beide Seitenspalten, vor und nach dem Text, Fußzeile — und so oft, wie man will: Jeder Eintrag ist eine eigene Box mit eigenen Optionen. → 3

HTML oder Markdown, aus einer Datei oder direkt aus der Konfiguration

Ein Markdown-Schnipsel wird beim Bauen zu HTML. Liegt er als Datei vor, wirkt eine Änderung in der Vorschau beim nächsten Neuladen, ohne Neustart. → 2

Platzhalter

Seitentitel, Site-Titel, Pfad der Seite, der Weg zur Startseite und jedes Frontmatter-Feld lassen sich einsetzen — eine Box, die auf jeder Seite etwas anderes sagt. → 4

Überschrift, Aufklappen, eigene Klasse

Eine Box kann eine Überschrift tragen und sich auf- und zuklappen lassen, ganz ohne JavaScript. Mit einer eigenen Klasse wird sie gestaltet; Bilder gibt es in einer Fassung je Farbschema. → 5

Je Seite steuerbar

Eine einzelne Seite blendet die Box über ihr Frontmatter aus oder tauscht Schnipsel und Überschrift. → 6

In jeder Sprache ihr eigener Text

Mit byLang bekommt jede Sprache ihre eigene Datei, ihren eigenen Text und ihre eigene Überschrift — passend zu quartz-multilanguage. → 7

Das Plugin arbeitet vollständig beim Bauen und liefert kein JavaScript an den Browser aus.

Diese Website ist ihr eigener Beleg

Sie ist mit dem Plugin gebaut. Die Wortmarke oben links, der Kapitelname daneben und die Box unten in der linken Spalte sind drei Layout-Boxen; Kapitel 8 nimmt jede davon auseinander.

Die neun Kapitel

Kapitel	Die Frage, die es beantwortet
1 – Einstieg	Wozu das Plugin, und wie steht die erste Box?
2 – Der Schnipsel	Datei oder Konfiguration, HTML oder Markdown?
3 – Platzierung	Wo darf eine Box stehen, und in welcher Reihenfolge?
4 – Platzhalter	Wie kommt der Seitentitel in die Box?
5 – Form	Überschrift, Aufklappen, eigene Klasse — und wie man gestaltet
6 – Je Seite	Wie blendet eine einzelne Seite die Box aus oder tauscht sie?
7 – Zwei Sprachen	Wie bekommt jede Sprache ihren eigenen Text?
8 – Rezepte	Fertige Beispiele, die auf dieser Seite zu sehen sind
9 – Nachschlagen	Alle Optionen, alle Fehlermeldungen, das Glossar

In einer Minute

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

Ein Schnipsel unter quartz/static/snippets/snippet.html anlegen, den Eintrag in die quartz.config.yaml schreiben, fertig:

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

Ausführlich steht das unter 1.2 – Die erste Box.

Wo es sonst noch steht

Die Kurzfassung ist die README des Repositorys — dieselben Optionen, ohne Beispiele. Das Plugin gehört zu QuartzControl, wo es sich ohne YAML einrichten lässt; nötig ist die App aber nicht.