Que fait SiteKit ?
SiteKit est un générateur de sites statiques Swift, pensé pour l'IA et construit autour d'un pipeline orienté phases : Découverte → Chargement → Enrichissement → Rendu des pages → Rendu système → Traitement de la sortie, avec en plus le téléportage d'actifs indépendant du contenu. Chaque phase correspond à un protocole Swift ; les sites sont composés à l'aide des méthodes factory de SiteBuilder (.blog(), .podcast(), .newsletter(), .portfolio(), .docs(), .docc()) et personnalisés de manière fluide en remplaçant ou en ajoutant des plugins.
Processus
Acheminez l'intention de l'utilisateur vers la bonne référence. Ne lisez que les références nécessaires à la tâche en cours.
| Si l'utilisateur demande… | Alors lisez… |
|---|---|
L'installation de SiteKit et la génération du premier site (la CLI sitekit) | references/bootstrap.md |
| La configuration d'un nouveau site à partir de zéro | references/onboarding.md |
| Le choix d'un blueprint (Blog, Newsletter, Podcast, Portfolio, AppLanding, Snippets, IndieDev, DocC, Plain) | references/blueprints.md |
| La rédaction de contenu (articles de blog, numéros de newsletter, pages statiques) | references/content-writing.md |
| Les pages légales (mentions légales, confidentialité – selon le pays, RGPD, cookies) | references/legal-pages.md |
Les extensions DocC / directives Markdown (@Metadata, @Row, @TabNavigator, @Video, @Image, @Links, …) + le contrat de dégradation élégante | references/markdown-extensions.md |
| Les sites multilingues (traductions, suffixes de locale, validation) | references/localization.md |
| L'audit d'accessibilité (contraste WCAG AA, texte alternatif, navigation clavier) | references/accessibility.md |
| Le référencement SEO + ASO + la découvrabilité par l'IA (URL canoniques, OG, JSON-LD, llms.txt) | references/seo-aso.md |
| Les performances / résultats PageSpeed (LCP, CLS, ressources bloquant le rendu) | references/performance.md |
| Le déploiement du site (matrice hébergeur + CI) – commencez ici | references/deployment/SKILL.md |
| La personnalisation du thème (préréglages, schémas de couleurs, associations de polices, tokens) | references/themes.md |
L'ajout d'une Page personnalisée pour un nouveau type de page HTML | references/custom-pages.md |
L'extension du pipeline (Loader, Enricher, Renderer, OutputProcessor, Teleporter) | references/architecture.md |
| Le dépannage de la construction ou de l'exécution | references/troubleshooting.md |
| La configuration d'une newsletter auto-hébergée (Keila + SMTP) | references/newsletter-setup.md |
| Le choix de services externes (envoi d'emails, intégrations) | references/external-services.md |
La référence des champs de SiteConfig.yaml | references/siteconfig-reference.md |
Déploiement – accédez directement à un fournisseur
references/deployment/SKILL.md est l'orchestrateur : il détecte la variante du Package.swift , demande le mode de configuration, et gère l'authentification CLI avant de diriger vers un fichier CI + un fichier hébergeur. Commencez par là pour un déploiement frais. Si vous connaissez déjà la cible (p. ex. reconfiguration d'un déploiement existant), accédez directement :
| Si l'utilisateur demande… | Alors lisez… |
|---|---|
| CI sur GitHub Actions | references/deployment/ci/github-actions.md |
| CI sur GitLab CI | references/deployment/ci/gitlab-ci.md (communautaire ; placeholder) |
| CI sur Xcode Cloud | references/deployment/ci/xcode-cloud.md (communautaire ; placeholder) |
| CI sur Bitrise | references/deployment/ci/bitrise.md (communautaire ; placeholder) |
| Hébergement sur Cloudflare Pages | references/deployment/hosts/cloudflare-pages.md |
| Hébergement sur GitHub Pages | references/deployment/hosts/github-pages.md |
| Hébergement sur Netlify | references/deployment/hosts/netlify.md |
| Hébergement sur Vercel | references/deployment/hosts/vercel.md |
| Quels fournisseurs de CI sont supportés / comment en ajouter un nouveau | references/deployment/ci/README.md |
| Quels hébergeurs sont supportés / comment en ajouter un nouveau | references/deployment/hosts/README.md |
Accéder directement contourne le mode de configuration et la détection du Package.swift de l'orchestrateur – ne le faites que lorsque ces étapes sont déjà réglées.
Vocabulaire essentiel (toujours disponible)
- Blueprint – une recette pour un type de site.
SiteBuilderexpose des méthodes factory (.blog(),.podcast(),.newsletter(),.portfolio(),.docs(),.docc()) qui précomposent la liste de plugins par défaut pour chaque type de site. Les blueprints sur disque sousPlugin/blueprints/sont des sites de démarrage que le plugin peut cloner. - Page – le protocole orienté utilisateur pour le rendu des pages HTML. C'est un sous-protocole de
Renderer. Les conformistes implémententpages(in:)etrenderHTML(_:context:);PageShell.wrap(content:page:context:)applique automatiquement le chrome standard<head>/<header>/<footer>. - Renderer – protocole de sortie au niveau système. Déclare
scope: .perLocale(par défaut – s'exécute une fois par locale) ou.global(s'exécute exactement une fois par build, utilisé pour le sitemap, robots, llms.txt,_headersde Cloudflare). Le pipeline distribue en fonction duscope. SiteBuilder– constructeur immuable et fluide. Chaque méthode de configuration (.renderer,.enricher,.processor,.teleporter, …) renvoie un nouveauSiteBuilder..run()lit les verbes CLI (build,serve,validate) et exécute le pipeline.BuildContext– état en lecture seule passé à chaque plugin des phases 3 à 6. Contientconfig,themeConfig,sections,staticPages,tags,homeContent,router,uiStrings,outputDirectory,projectDirectory.- Commandes de construction –
swift run Site buildécrit le site dans_Site/.swift run Site servelance le serveur de développement (par défaut:8080).swift run Site validatevérifie l'exhaustivité des traductions sur les sites multilingues (les sites monolingues réussissent trivialement).--base-url <url>sur build/serve remplaceSiteConfig.baseURLpour cette exécution (déploiements de préproduction).
Note de style
Lorsque vous générez du contenu pour le site via cette skill, gardez une voix authentique et indépendante. Phrases courtes. Pronoms personnels. Pas de langue de bois corporative. Le guide complet de la voix de l'auteur et les instructions d'apprentissage en boucle se trouvent dans references/content-writing.md.
Aperçu du pipeline
| Phase | Protocole | Où étendre |
|---|---|---|
| 0. Téléportage d'actifs (indépendant du contenu) | Teleporter | .teleporter(_:) |
| 1. Découverte | ContentDiscovery | .contentDiscovery(_:) |
| 2. Chargement | Loader<Source, Output> | .articleLoader(_:), .staticPageLoader(_:) |
| 3. Enrichissement | Enricher | .enricher(_:) |
| 4. Pages HTML par locale | Page (sous-protocole de Renderer) | .renderer(_:) |
| 5. Rendu système | Renderer + RenderScope | .renderer(_:) |
| 6. Traitement de la sortie | OutputProcessor | .processor(_:) |
Pour l'architecture complète et des exemples concrets de chaque point d'extension, lisez references/architecture.md et references/custom-pages.md.
Voir aussi
Si une tâche n'est couverte par aucune des références ci-dessus – vous modifiez la bibliothèque Swift de SiteKit elle-même plutôt que de construire un site avec – remontez à la référence contributeur à la racine du dépôt : AGENTS.md (détails internes du pipeline, protocoles de phase, points d'échange de SiteBuilder, commandes de build et de test).
Pour un index tâche → documentation qui couvre à la fois la documentation destinée aux humains et ces références, consultez ../../../USE-CASES.md à la racine du dépôt.