Bearbeiten mit clay edit

clay edit ist ein Editor im Terminal für alles rund um deine Seiten: Seiten und Ordner anlegen, ihr Front Matter, ihre Reihenfolge, sie umbenennen, verschieben und löschen, Übersetzungen, Versionen und die Einstellungen in der clay.yaml. Er schreibt dieselben Dateien, die du sonst von Hand bearbeitest; beide Wege lassen sich also beliebig mischen.

npx clay edit

┌  Clay · edit   Pages   Settings   latest · de
│
│   ⌂ Clay-Dokumentation          fa-solid fa-book-open
│   ◆ Einführung                  fa-solid fa-house
│ › ▾ Erste Schritte              fa-solid fa-rocket
│   │  ◆ Installation             fa-solid fa-download
│   │  ◆ Schnellstart             fa-solid fa-bolt
│   ▸ Schreiben                   fa-solid fa-pen-nib
│
└  ⏎ details · n page · f folder · m order · o move · r rename · x delete · v/V version · l language · tab · q

Änderungen werden sofort geschrieben, Datei für Datei, und der Editor zeigt, welche Dateien er geschrieben hat. Mit Git prüfst du sie oder machst sie rückgängig. Der Editor selbst ist englisch.

#Seiten und Ordner

Der Reiter Pages zeigt die Startseite (⌂), die Ordner (▾) und die Seiten (◆) in der Reihenfolge der Navigation. Grau dargestellte Titel sind Standardwerte, aus der ersten Überschrift oder dem Dateinamen.

Neue Seiten bekommen ihren Titel als Front Matter und als erste Überschrift, und einen Dateinamen aus dem Titel, den du vor dem Anlegen ändern kannst. Neue Ordner bekommen eine index.md mit ihrem Titel und list: true.

Beim Ordnen nummeriert Clay alles im Ordner durch (order: 1, 2, 3, …) und schreibt nur die Dateien, deren Nummer sich geändert hat.

Umbenennen und Verschieben nehmen die Übersetzungen der Seite mit und fragen, ob die alte Adresse auf die neue weiterleiten soll. Links auf den Eintrag schreibt Clay nicht um; stattdessen listet es die Links, die dadurch kaputtgegangen sind, damit du sie korrigieren kannst:

Moved setup.md → guides/setup.md · 2 link(s) broke: introduction.md: "setup.md" points to a missing page (/setup) …

#Die Details

⏎ öffnet alle Front-Matter-Felder des gewählten Eintrags: Titel, Icon, Beschreibung und Reihenfolge, für Ordner und die Startseite auch list und hero (siehe Indexseiten). Wähle ein Feld und drück ⏎, um es zu ändern; Ja/Nein-Felder schaltest du mit ⏎ um. Esc führt zurück zur Liste.

In einem Textfeld übernimmt ⏎ die Eingabe, Esc bricht ab. Lass ein Feld leer, um den Wert zu entfernen und zum Standard zurückzukehren. Für einen Ordner ohne index.md legt der Editor eine an.

#Versionen und Sprachen

Die Kopfzeile zeigt, welche Version und Sprache du bearbeitest.

In einer anderen Sprache sind Seiten ohne Übersetzung als untranslated markiert. Setzt du ein Feld einer solchen Seite, legt der Editor die Übersetzung zuerst aus dem Original an. Die Reihenfolge ist in jeder Sprache gleich; du änderst sie deshalb in der Standardsprache.

#Einstellungen

Der Reiter Settings listet die Einstellungen der clay.yaml. Wähle eine aus und drück ⏎, um sie zu ändern. Einstellungen mit einem Wert pro Sprache bearbeitest du in der Sprache, die die Kopfzeile zeigt. Links der Navigationsleiste fügst du mit + Add link hinzu und entfernst sie mit d.

Clay ändert nur die Werte, die du bearbeitest. Kommentare, Anführungszeichen, die Reihenfolge der Schlüssel und der Rest jeder Datei bleiben, wie sie waren; der Diff in Git zeigt also genau deine Änderung.

#Aus Skripten und für KI-Agenten

Jede Aktion des Editors ist auch ein Befehl, der eine Änderung macht und sich beendet. Skripte und KI-Agenten nutzen sie, weil sie kein Terminal haben, um den Editor zu bedienen; clay edit ohne Befehl erklärt sie, wenn es ohne Terminal läuft.

Pfade sind relativ zur Dokumentation, docs/ oder mit Versionen docs/latest/: guides/setup.md (das .md darf fehlen), guides für einen Ordner, index.md für die Startseite. --lang arbeitet in einer anderen Sprache, --docs-version in einer älteren Version, und --json gibt das Ergebnis als JSON aus.

npx clay edit set guides/setup.md title="Einrichtung" order=2 --json

{
  "ok": true,
  "written": ["docs/guides/setup.md"]
}

Mit npx clay edit help siehst du jeden Befehl mit Beispielen, und npx clay check nach Änderungen meldet kaputte Links und Einstellungen, ohne zu bauen. Siehe KI & Agenten.