QuartzControl ist die Oberfläche für Quartz, einen Generator für statische Websites. Ohne sie bedient man Quartz über die Kommandozeile und bearbeitet seine Konfiguration im Texteditor; mit ihr klickt man. Dieses Handbuch erklärt jeden Bildschirm von QuartzControl — was er tut, wann man ihn braucht und was man dort besser nicht tut.
Die Übersicht eines Projekts: Vorschau, Build, Veröffentlichen, Snapshots und Updates auf einen Blick.
Was QuartzControl kann
Aus Notizen wird eine Website
Ein Obsidian-Vault oder irgendein Ordner wird zum Content-Ordner — verknüpft, wenn man in Obsidian weiterschreiben will, kopiert, wenn nicht. Umstellen geht später, ohne eine Notiz zu verlieren. → 3.4
Gestalten, ohne CSS zu schreiben
Plugins aus einem Marktplatz
Durchsuchen, installieren, einstellen — mit einem Formular statt YAML, und mit einer Reihenfolge, die man zieht statt tippt. → 4.8
Ansehen, bevor es jemand anders sieht
Die Vorschau läuft im Hintergrund und baut bei jeder Änderung neu; die Ausgabe von Quartz steht im selben Fenster. → 5.1
Veröffentlichen, wohin man will
GitHub Pages, SFTP, rsync, FTP, ein Ordner oder ein Webhook — mit einer Liste dessen, was übertragen wird, bevor es übertragen wird. Zugangsdaten liegen verschlüsselt im Schlüsselbund des Systems. → 6
Ein Weg zurück
Vor jeder größeren Änderung legt QuartzControl selbst einen Snapshot an, auch vor einem Quartz-Update. Und jede Änderung landet in der Datei, in der sie auch von Hand gelandet wäre — das Projekt bleibt ohne QuartzControl weiterführbar. → 7
Dazu: mehrere Projekte nebeneinander, die festen Texte der Website („Suche“, „Zurück“) in jeder Sprache bearbeitbar, Vorlagenpakete zum Weitergeben einer Gestaltung — und das alles in einem Programm, das sein eigenes Node und git mitbringt. Installieren muss man nichts außer QuartzControl.
Zwei Vorlagen
Beide stammen aus einem Guss: Farben, deren Kontrast in hell und dunkel gemessen ist, vier eigene Seitenraster für Smartphone, Tablet und Desktop, selbst ausgelieferte Schriften (Noto Sans und Noto Sans Mono, keine Anfrage an Google), ein Stylesheet je Komponente und 66 CSS-Variablen, die in QuartzControl unter Stile → Variablen stehen.
Basis-Template — der Start für ein eigenes Projekt
Bietet QuartzControl beim Anlegen an. Je Plugin nur die nötigen Komponenten: eine Marke im Kopf, eine Navigation links, ein Sprachumschalter, eine Box in der Seitenleiste. Alle übrigen sind trotzdem fertig gestaltet — wer eine einschaltet, bekommt sie so, wie sie gedacht ist. Dazu, abwählbar, kurze Beispielseiten in zwei Sprachen, die zum Löschen gedacht sind.
Example — die Vorführung
Dieselbe Gestaltung mit jeder Komponente im Einsatz, und ein zweisprachiges Handbuch in sieben Kapiteln, das zeigt, wie man Notizen schreibt, damit daraus gute Seiten werden. Anzusehen unter boxi-os.github.io/Quartz-Example-Template; das Paket
qc-example.qtplliegt in quartzcontrol-templates und kommt über Vorlagen → Vorlage anwenden in ein bestehendes Projekt.
Drei Plugins, die dazugehören
Für die Vorlagen fehlten Quartz drei Dinge. Sie sind als eigenständige Plugins entstanden, laufen in jedem Quartz-5-Projekt — mit oder ohne QuartzControl — und haben je ein eigenes Handbuch auf Deutsch und Englisch.
| Plugin | Was es tut |
|---|---|
| Layout Box | Ein Schnipsel HTML oder Markdown an jeder Stelle der Seite — Logo, Hinweis, Box in der Seitenleiste. Mit Platzhaltern, einklappbar, je Seite und je Sprache umschaltbar. |
| Multilanguage | Dieselben Notizen in mehreren Sprachen: Sprache je Seite erkennen, Übersetzungen verknüpfen, Sprachumschalter, hreflang, Weiterleitung auf die Sprache des Browsers. |
| Navigations | Navigationen aus der Ordnerstruktur: Menüleiste, Akkordeon, Sitemap, Vor/Zurück unter dem Text — zehn Varianten, beliebig viele Instanzen, eigenes Verhalten auf dem Smartphone. |
Die acht Kapitel
Neu hier? Kapitel 1 erklärt, was Obsidian, Quartz und QuartzControl miteinander zu tun haben, und begleitet die erste Website von der Installation bis zur Vorschau.
| Kapitel | Die Frage, die es beantwortet |
|---|---|
| 1 – Einstieg | Was ist das hier, und was nimmt QuartzControl mir ab? |
| 2 – Projekte | Wie lege ich ein Projekt an, hole eines dazu, kopiere es? |
| 3 – Einrichtung | Titel, Adresse, Sprache — und wo meine Notizen herkommen. |
| 4 – Gestaltung | Farben, Schriften, Seitenraster, Plugins, Vorlagen. |
| 5 – Ansehen und bauen | Wie sehe ich das Ergebnis, bevor es jemand anders sieht? |
| 6 – Veröffentlichen | Wie kommt die Website auf einen Server? |
| 7 – Wartung | Zurückholen, aktualisieren, aufräumen. |
| 8 – Nachschlagen | Was heißt dieses Wort? Was geht nicht, und warum? |
QuartzControl selbst
| Seite | Wofür |
|---|---|
| Beziehen und aktualisieren | Welche Form zu welchem System gehört, was macOS beim ersten Start blockiert, wie eine neue Fassung nachrückt |
| Systemvoraussetzungen | Welche Systeme laufen, was QuartzControl selbst mitbringt, warum es kein Windows gibt |
| Aus dem Quelltext bauen | Selbst übersetzen, und welche Prüfungen an QuartzControl hängen |
Was sich von Fassung zu Fassung geändert hat, steht auf den Release-Seiten.
Was hier nicht steht
Wie man Notizen schreibt, damit daraus gute Seiten werden — Formatierung, Callouts, Bases, Canvas, Frontmatter —, steht im Handbuch der Vorlage Example (oben). Es ist selbst mit QuartzControl gebaut und zeigt zu jeder Möglichkeit die Seite, auf der sie beschrieben ist.
Wie Quartz intern arbeitet, steht in der Quartz-Dokumentation. Dieses Handbuch erklärt QuartzControl, die Oberfläche davor.