Zum Inhalt springen
Das ist die Dokumentation für Clay 4.x. Zur neuesten Version (5.x)
Auf dieser Seite

Konfiguration

Einstellungen liegen an drei Orten, von der ganzen Website bis zur einzelnen Seite:

#Die drei Orte

Die Website: Titel, Adressen, Links in der Navigationsleiste, Versionen und Sprachen.

title: "Mein Projekt"
baseURL: "/mein-projekt/"
siteURL: "https://meine-org.github.io"
languages: ["en", "de"]

#Welcher Wert gewinnt

Clays Standardwerte clay.yaml Umgebungsvariablen

Ein weiter rechts gesetzter Wert ersetzt den davor. Front Matter gehört zu einer einzelnen Seite und kommt den anderen nie in die Quere.

#Das Wichtigste

  • Alles hat einen Standardwert. Eine clay.yaml nur mit title und schlichte Markdown-Dateien ergeben eine funktionierende Website.
  • Umgebungsvariablen gewinnen. Sie überschreiben die clay.yaml für einen Build, ohne die Datei zu ändern.
  • Tippfehler werden gemeldet. Ein unbekannter Schlüssel in der clay.yaml ist bei jedem Build eine Warnung, siehe Build-Prüfungen.
  • YAML musst du nicht von Hand bearbeiten. clay edit ändert Einstellungen und Front Matter und behält deine Kommentare und Formatierung. Siehe clay edit.