[{"data":1,"prerenderedAt":26},["ShallowReactive",2],{"clay-page:\u002F3.x\u002Fde\u002Fgetting-started\u002Finstallation":3},{"html":4,"toc":5,"description":22,"hero":23,"list":24,"socialImage":25},"\u003Ch1 id=\"installation\">Installation\u003C\u002Fh1>\n\u003Cp>Clay ist auf npm als \u003Ca href=\"https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fclay-doc\" target=\"_blank\" rel=\"noopener noreferrer\">\u003Ci class=\"fa-solid fa-arrow-up-right-from-square clay-external-icon\" aria-hidden=\"true\">\u003C\u002Fi>\u003Ccode>clay-doc\u003C\u002Fcode>\u003C\u002Fa> veröffentlicht. Es braucht \u003Cstrong>Node.js 20.19 oder neuer\u003C\u002Fstrong>, das \u003Ccode>npm\u003C\u002Fcode> und \u003Ccode>npx\u003C\u002Fcode> mitbringt.\u003C\u002Fp>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">node\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --version\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#006400;--shiki-dark:#6A9955\">   # v20.19.0 oder neuer\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Ch2 id=\"clay-zu-einem-projekt-hinzufügen\">\u003Ca class=\"heading-anchor\" href=\"#clay-zu-einem-projekt-hinzufügen\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#clay-zu-einem-projekt-hinzufügen\">#\u003C\u002Fa>Clay zu einem Projekt hinzufügen\u003C\u002Fh2>\n\u003Cp>Installiere Clay als Entwicklungsabhängigkeit des Projekts, das du dokumentieren möchtest:\u003C\u002Fp>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npm\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> install\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --save-dev\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay-doc\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Cp>Damit steht Clay in der \u003Ccode>package.json\u003C\u002Fcode>, und die genaue Version ist in der \u003Ccode>package-lock.json\u003C\u002Fcode> festgehalten. So nutzt jeder Build, auf deinem Rechner wie in der CI, dieselbe Version.\u003C\u002Fp>\n\u003Cp>Ergänze Skripte in der \u003Ccode>package.json\u003C\u002Fcode>, damit sich niemand die Befehle merken muss:\u003C\u002Fp>\n\u003Cdiv class=\"code-block\">\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">{\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#0451A5;--shiki-dark:#9CDCFE\">  \"scripts\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: {\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#0451A5;--shiki-dark:#9CDCFE\">    \"docs:dev\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"clay dev\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#0451A5;--shiki-dark:#9CDCFE\">    \"docs:build\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"clay build\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#0451A5;--shiki-dark:#9CDCFE\">    \"docs:preview\"\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"clay preview\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">  }\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">}\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Cp>Dann startet \u003Ccode>npm run docs:dev\u003C\u002Fcode> die Live-Vorschau.\u003C\u002Fp>\n\u003Cdiv class=\"markdown-alert markdown-alert-tip\">\n\u003Cp class=\"markdown-alert-title text-primary\">\u003Ci class=\"fa-solid fa-lightbulb mr-2\">\u003C\u002Fi>Tipp\u003C\u002Fp>\n\u003Cp>Clay installiert zwei Befehle, \u003Ccode>clay\u003C\u002Fcode> und \u003Ccode>clay-doc\u003C\u002Fcode>. Sie tun dasselbe; nimm den, der sich in deinen Skripten besser liest.\u003C\u002Fp>\n\u003C\u002Fdiv>\n\u003Ch2 id=\"clay-ausprobieren-ohne-es-zu-installieren\">\u003Ca class=\"heading-anchor\" href=\"#clay-ausprobieren-ohne-es-zu-installieren\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#clay-ausprobieren-ohne-es-zu-installieren\">#\u003C\u002Fa>Clay ausprobieren, ohne es zu installieren\u003C\u002Fh2>\n\u003Cp>In jedem Ordner mit einer \u003Ccode>clay.yaml\u003C\u002Fcode> und einem \u003Ccode>docs\u002F\u003C\u002Fcode>-Ordner führt \u003Ccode>npx\u003C\u002Fcode> Clay direkt von npm aus:\u003C\u002Fp>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npx\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay-doc\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> dev\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Cp>Das ist praktisch für einen ersten Blick. Für Builds in der CI nimm eine feste Version, entweder über die \u003Ccode>package.json\u003C\u002Fcode> oder mit ausdrücklicher Version:\u003C\u002Fp>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npx\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay-doc@2.1.0\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> build\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --strict\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Ch2 id=\"projekte-ohne-packagejson\">\u003Ca class=\"heading-anchor\" href=\"#projekte-ohne-packagejson\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#projekte-ohne-packagejson\">#\u003C\u002Fa>Projekte ohne package.json\u003C\u002Fh2>\n\u003Cp>Dokumentation liegt oft in Repositories, die in Go, Python, Java oder anderen Sprachen geschrieben sind. Dort brauchst du keine \u003Ccode>package.json\u003C\u002Fcode>: Führe Clay lokal und in der CI mit \u003Ccode>npx clay-doc@<version>\u003C\u002Fcode> aus. Der Nachteil: Werkzeuge wie Dependabot können eine Version, die in einem Befehl steht, nicht aktualisieren, das musst du selbst tun.\u003C\u002Fp>\n\u003Ch2 id=\"clay-aktualisieren\">\u003Ca class=\"heading-anchor\" href=\"#clay-aktualisieren\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#clay-aktualisieren\">#\u003C\u002Fa>Clay aktualisieren\u003C\u002Fh2>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npm\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> install\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --save-dev\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay-doc@latest\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Cp>Clay folgt der \u003Ca href=\"https:\u002F\u002Fsemver.org\u002Flang\u002Fde\u002F\" target=\"_blank\" rel=\"noopener noreferrer\">\u003Ci class=\"fa-solid fa-arrow-up-right-from-square clay-external-icon\" aria-hidden=\"true\">\u003C\u002Fi>semantischen Versionierung\u003C\u002Fa>: Minor- und Patch-Releases bringen neue Funktionen und Fehlerbehebungen, ohne deine Dokumentation zu beschädigen. Das \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fclay-doc\u002Fclay\u002Fblob\u002Fmain\u002FCHANGELOG.md\" target=\"_blank\" rel=\"noopener noreferrer\">\u003Ci class=\"fa-solid fa-arrow-up-right-from-square clay-external-icon\" aria-hidden=\"true\">\u003C\u002Fi>Changelog\u003C\u002Fa> listet jede Änderung.\u003C\u002Fp>\n\u003Ch2 id=\"nächste-schritte\">\u003Ca class=\"heading-anchor\" href=\"#nächste-schritte\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#nächste-schritte\">#\u003C\u002Fa>Nächste Schritte\u003C\u002Fh2>\n\u003Cp>Weiter geht es mit dem \u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fde\u002Fgetting-started\u002Fquick-start\" data-route=\"\u002F3.x\u002Fde\u002Fgetting-started\u002Fquick-start\">Schnellstart\u003C\u002Fa>, in dem du deine erste Seite baust.\u003C\u002Fp>\n",[6,10,13,16,19],{"id":7,"text":8,"level":9},"clay-zu-einem-projekt-hinzufügen","Clay zu einem Projekt hinzufügen",2,{"id":11,"text":12,"level":9},"clay-ausprobieren-ohne-es-zu-installieren","Clay ausprobieren, ohne es zu installieren",{"id":14,"text":15,"level":9},"projekte-ohne-packagejson","Projekte ohne package.json",{"id":17,"text":18,"level":9},"clay-aktualisieren","Clay aktualisieren",{"id":20,"text":21,"level":9},"nächste-schritte","Nächste Schritte","Installiere Clay mit npm in ein Projekt, oder probiere es aus, ohne etwas zu installieren.",null,false,"\u002F_clay\u002Fsocial\u002F3.x\u002Fde\u002Fgetting-started\u002Finstallation.png",1792666370989]