Was macht SiteKit?
SiteKit ist ein KI-zentrierter, statischer Seitengenerator in Swift, der auf einer phasenorientierten Pipeline basiert: Discovery → Loading → Enrichment → Page Rendering → System Rendering → Output Processing, ergänzt durch inhaltsunabhängiges Asset Teleporting. Jede Phase ist als Swift-Protokoll implementiert; Websites werden mit den Factory-Methoden von SiteBuilder (.blog(), .podcast(), .newsletter(), .portfolio(), .docs(), .docc()) zusammengestellt und durch das Austauschen oder Hinzufügen von Plugins flexibel angepasst.
Vorgehen
Leiten Sie die Absicht des Benutzers zur richtigen Referenz weiter. Lesen Sie nur die Referenzen, die Sie für die aktuelle Aufgabe benötigen.
| Wenn der Benutzer fragt nach… | Dann lesen Sie… |
|---|---|
Installation von SiteKit + Aufsetzen der ersten Website (die sitekit-CLI) | references/bootstrap.md |
| Einrichten einer neuen Website von Grund auf | references/onboarding.md |
| Auswahl einer Blaupause (Blog, Newsletter, Podcast, Portfolio, AppLanding, Snippets, IndieDev, DocC, Plain) | references/blueprints.md |
| Schreiben von Inhalten (Blogbeiträge, Newsletter-Ausgaben, statische Seiten) | references/content-writing.md |
| Impressum / Datenschutz / Rechtliche Seiten (länderabhängig, DSGVO, Cookies) | references/legal-pages.md |
DocC / Markdown-Direktivenerweiterungen (@Metadata, @Row, @TabNavigator, @Video, @Image, @Links, …) + der Graceful-Degradation-Vertrag | references/markdown-extensions.md |
| Mehrsprachige Websites (Übersetzungen, Gebietsschema-Suffixe, Validierung) | references/localization.md |
| Barrierefreiheits-Audit (WCAG AA Kontrast, Alt-Texte, Tastaturnavigation) | references/accessibility.md |
| SEO + ASO + KI-Auffindbarkeit (kanonische URLs, OG, JSON-LD, llms.txt) | references/seo-aso.md |
| Leistung / PageSpeed-Ergebnisse (LCP, CLS, render-blocking) | references/performance.md |
| Bereitstellen der Website (Host- + CI-Anbieter-Matrix) – hier beginnen | references/deployment/SKILL.md |
| Theme-Anpassung (Voreinstellungen, Farbschemata, Schriftkombinationen, Tokens) | references/themes.md |
Hinzufügen einer benutzerdefinierten Page für einen neuen HTML-Seitentyp | references/custom-pages.md |
Erweitern der Pipeline (Loader, Enricher, Renderer, OutputProcessor, Teleporter) | references/architecture.md |
| Fehlerbehebung bei Build / Laufzeit | references/troubleshooting.md |
| Selbst gehostetes Newsletter-Setup (Keila + SMTP) | references/newsletter-setup.md |
| Auswahl externer Dienste (E-Mail-Versand, Integrationen) | references/external-services.md |
SiteConfig.yaml Feldreferenz | references/siteconfig-reference.md |
Deployment – direkt zu einem Anbieter springen
references/deployment/SKILL.md ist der Orchestrator: Er erkennt die Package.swift-Variante, fragt nach dem Setup-Modus und führt die CLI-Authentifizierung durch, bevor er zu einer CI- und einer Hosting-Datei weiterleitet. Beginnen Sie hier für ein frisches Deployment. Wenn Sie das Ziel bereits kennen (z. B. Neukonfiguration eines bestehenden Deployments), können Sie direkt springen:
| Wenn der Benutzer fragt nach… | Dann lesen Sie… |
|---|---|
| CI auf GitHub Actions | references/deployment/ci/github-actions.md |
| CI auf GitLab CI | references/deployment/ci/gitlab-ci.md (Community; Platzhalter) |
| CI auf Xcode Cloud | references/deployment/ci/xcode-cloud.md (Community; Platzhalter) |
| CI auf Bitrise | references/deployment/ci/bitrise.md (Community; Platzhalter) |
| Hosting auf Cloudflare Pages | references/deployment/hosts/cloudflare-pages.md |
| Hosting auf GitHub Pages | references/deployment/hosts/github-pages.md |
| Hosting auf Netlify | references/deployment/hosts/netlify.md |
| Hosting auf Vercel | references/deployment/hosts/vercel.md |
| Welche CI-Anbieter unterstützt werden / Hinzufügen eines neuen CI-Anbieters | references/deployment/ci/README.md |
| Welche Hosts unterstützt werden / Hinzufügen eines neuen Hosting-Anbieters | references/deployment/hosts/README.md |
Ein direkter Sprung überspringt den Setup-Modus des Orchestrators und die Package.swift-Erkennung – tun Sie dies nur, wenn diese bereits geklärt sind.
Kernvokabular (immer verfügbar)
- Blueprint – ein Rezept für einen Website-Typ.
SiteBuilderstellt Factory-Methoden bereit (.blog(),.podcast(),.newsletter(),.portfolio(),.docs(),.docc()), die die Standard-Plugin-Liste für jeden Website-Typ vorab zusammenstellen. Blaupausen auf der Festplatte unterPlugin/blueprints/sind Starter-Seiten, die das Plugin klonen kann. - Page – das benutzerorientierte Protokoll für die HTML-Seitenwiedergabe. Es ist ein Unterprotokoll von
Renderer. Konforme Implementierungen implementierenpages(in:)undrenderHTML(_:context:);PageShell.wrap(content:page:context:)wendet automatisch das standardmäßige<head>/<header>/<footer>-Chrome an. - Renderer – System-Ausgabeprotokoll. Deklariert
scope: .perLocale(Standard – läuft einmal pro Gebietsschema) oder.global(läuft genau einmal pro Build, verwendet für Sitemap, robots, llms.txt, Cloudflare_headers). Die Pipeline verteilt nachscope. SiteBuilder– immutable, flüssiger Builder. Jede Konfigurationsmethode (.renderer,.enricher,.processor,.teleporter, …) gibt einen neuenSiteBuilderzurück..run()liest CLI-Verben (build,serve,validate) und führt die Pipeline aus.BuildContext– Read-Only-Zustand, der an alle Plugins der Stufen 3–6 übergeben wird. Enthältconfig,themeConfig,sections,staticPages,tags,homeContent,router,uiStrings,outputDirectory,projectDirectory.- Build-Befehle –
swift run Site buildschreibt die Website nach_Site/.swift run Site servestartet den Entwicklungsserver (Standard:8080).swift run Site validateprüft die Übersetzungsvollständigkeit bei mehrsprachigen Websites (einsprachige Websites bestehen trivial).--base-url <url>bei build/serve überschreibtSiteConfig.baseURLfür diesen Durchlauf (Staging-Deployments).
Stilhinweis
Verwenden Sie bei der Generierung von Website-Inhalten durch dieses Skill eine authentische Indie-Stimme. Kurze Absätze. Persönliche Pronomen. Kein korporatives Herumeiern. Die vollständige Autorenstimmen-Anleitung und die Lernschleifen-Anweisungen befinden sich in references/content-writing.md.
Pipeline auf einen Blick
| Phase | Protokoll | Wo erweitern |
|---|---|---|
| 0. Asset-Teleport (inhaltsunabhängig) | Teleporter | .teleporter(_:) |
| 1. Discovery | ContentDiscovery | .contentDiscovery(_:) |
| 2. Loading | Loader<Source, Output> | .articleLoader(_:), .staticPageLoader(_:) |
| 3. Enrichment | Enricher | .enricher(_:) |
| 4. Pro-Gebietsschema-HTML-Seiten | Page (Unterprotokoll von Renderer) | .renderer(_:) |
| 5. System-Rendering | Renderer + RenderScope | .renderer(_:) |
| 6. Ausgabeverarbeitung | OutputProcessor | .processor(_:) |
Die vollständige Architektur-Begründung und ausgearbeitete Beispiele für jeden Erweiterungspunkt finden Sie in references/architecture.md und references/custom-pages.md.
Siehe auch
Wenn eine Aufgabe von keiner der obigen Referenzen abgedeckt wird – Sie also SiteKits eigene Swift-Bibliothek modifizieren, anstatt eine Website damit zu bauen – eskalieren Sie zur Mitwirkungsreferenz im Repository-Stamm: AGENTS.md (Pipeline-Interna, Phasenprotokolle, SiteBuilder-Austauschpunkte, Build- und Test-Befehle).
Für einen Aufgaben → Dokumentations-Index, der sowohl die menschenlesbaren Dokumentationen als auch diese Referenzen umfasst, siehe ../../../USE-CASES.md im Repository-Stamm.