O que SiteKit faz?
SiteKit é um gerador de sites estáticos Swift com foco em IA, construído em torno de um pipeline orientado por fases: Descoberta → Carregamento → Enriquecimento → Renderização de páginas → Renderização do sistema → Processamento da saída, além do teleporte de ativos independente de conteúdo. Cada fase é um protocolo Swift; os sites são compostos com métodos fábrica do SiteBuilder (.blog(), .podcast(), .newsletter(), .portfolio(), .docs(), .docc()) e personalizados fluentemente, trocando ou adicionando plugins.
Processo
Direcione a intenção do usuário para a referência correta. Leia apenas as referências necessárias para a tarefa atual.
| Se o usuário perguntar sobre… | Então leia… |
|---|---|
Instalação do SiteKit + criação do primeiro site (a CLI sitekit) | references/bootstrap.md |
| Configuração de um novo site do zero | references/onboarding.md |
| Escolha de um blueprint (Blog, Newsletter, Podcast, Portfolio, AppLanding, Snippets, IndieDev, DocC, Plain) | references/blueprints.md |
| Escrita de conteúdo (posts de blog, edições de newsletter, páginas estáticas) | references/content-writing.md |
| Páginas de Imprint / privacidade / legais (dependente do país, GDPR, cookies) | references/legal-pages.md |
DocC / extensões de diretivas Markdown (@Metadata, @Row, @TabNavigator, @Video, @Image, @Links, …) + o contrato de degradação graciosa | references/markdown-extensions.md |
| Sites multilíngues (traduções, sufixos de localidade, validação) | references/localization.md |
| Auditoria de acessibilidade (contraste WCAG AA, texto alternativo, navegação por teclado) | references/accessibility.md |
| SEO + ASO + descoberta por IA (URLs canônicas, OG, JSON-LD, llms.txt) | references/seo-aso.md |
| Desempenho / descobertas do PageSpeed (LCP, CLS, bloqueio de renderização) | references/performance.md |
| Implantação do site (matriz de host + provedor de CI) – comece aqui | references/deployment/SKILL.md |
| Personalização do tema (predefinições, esquemas de cores, combinações de fontes, tokens) | references/themes.md |
Adicionar uma Page personalizada para um novo tipo de página HTML | references/custom-pages.md |
Estender o pipeline (Loader, Enricher, Renderer, OutputProcessor, Teleporter) | references/architecture.md |
| Solução de problemas de compilação / runtime | references/troubleshooting.md |
| Configuração de newsletter auto-hospedada (Keila + SMTP) | references/newsletter-setup.md |
| Escolha de serviços externos (envio de e-mail, integrações) | references/external-services.md |
Referência de campos do SiteConfig.yaml | references/siteconfig-reference.md |
Implantação – vá direto para um provedor
references/deployment/SKILL.md é o orquestrador: ele detecta a variante do Package.swift, pergunta o modo de configuração e orienta a autenticação via CLI antes de rotear para um arquivo de CI e um de hospedagem. Comece por lá para uma nova implantação. Se você já souber o destino (por exemplo, reconfigurando uma implantação existente), vá diretamente:
| Se o usuário perguntar sobre… | Então leia… |
|---|---|
| CI no GitHub Actions | references/deployment/ci/github-actions.md |
| CI no GitLab CI | references/deployment/ci/gitlab-ci.md (comunitário; placeholder) |
| CI no Xcode Cloud | references/deployment/ci/xcode-cloud.md (comunitário; placeholder) |
| CI no Bitrise | references/deployment/ci/bitrise.md (comunitário; placeholder) |
| Hospedagem no Cloudflare Pages | references/deployment/hosts/cloudflare-pages.md |
| Hospedagem no GitHub Pages | references/deployment/hosts/github-pages.md |
| Hospedagem no Netlify | references/deployment/hosts/netlify.md |
| Hospedagem no Vercel | references/deployment/hosts/vercel.md |
| Quais provedores de CI são suportados / como adicionar um novo provedor de CI | references/deployment/ci/README.md |
| Quais hosts são suportados / como adicionar um novo provedor de hospedagem | references/deployment/hosts/README.md |
Ir diretamente ignora o modo de configuração do orquestrador e a detecção do Package.swift – faça isso apenas quando esses itens já tiverem sido resolvidos.
Vocabulário principal (sempre disponível)
- Blueprint – uma receita para um tipo de site. O
SiteBuilderexpõe métodos fábrica (.blog(),.podcast(),.newsletter(),.portfolio(),.docs(),.docc()) que pré-compõem a lista de plugins padrão para cada tipo de site. Blueprints em disco sobPlugin/blueprints/são sites iniciais que o plugin pode clonar. - Page – o protocolo voltado ao usuário para renderização de páginas HTML. É um sub-protocolo de
Renderer. Os conformantes implementampages(in:)erenderHTML(_:context:);PageShell.wrap(content:page:context:)aplica automaticamente a estrutura padrão<head>/<header>/<footer>. - Renderer – protocolo de saída do sistema. Declara
scope: .perLocale(padrão – executa uma vez por localidade) ou.global(executa exatamente uma vez por build, usado para sitemap, robots, llms.txt, Cloudflare_headers). O pipeline despacha com base noscope. SiteBuilder– construtor imutável e fluido. Cada método de configuração (.renderer,.enricher,.processor,.teleporter, …) retorna um novoSiteBuilder..run()lê os verbos da CLI (build,serve,validate) e executa o pipeline.BuildContext– estado somente leitura passado para todos os plugins das Fases 3 a 6. Contémconfig,themeConfig,sections,staticPages,tags,homeContent,router,uiStrings,outputDirectory,projectDirectory.- Comandos de build –
swift run Site buildgrava o site em_Site/.swift run Site serveinicia o servidor de desenvolvimento (padrão:8080).swift run Site validateverifica a integridade das traduções em sites multilíngues (sites de idioma único passam trivialmente).--base-url <url>em build/serve substituiSiteConfig.baseURLpara aquela execução (implantação de staging).
Nota de estilo
Ao gerar conteúdo do site por meio desta skill, mantenha uma voz indie autêntica. Parágrafos curtos. Pronomes pessoais. Sem rodeios corporativos. O guia completo de voz do autor e as instruções de ciclo de aprendizado estão em references/content-writing.md.
Pipeline de relance
| Fase | Protocolo | Onde estender |
|---|---|---|
| 0. Teleporte de ativos (independente de conteúdo) | Teleporter | .teleporter(_:) |
| 1. Descoberta | ContentDiscovery | .contentDiscovery(_:) |
| 2. Carregamento | Loader<Source, Output> | .articleLoader(_:), .staticPageLoader(_:) |
| 3. Enriquecimento | Enricher | .enricher(_:) |
| 4. Páginas HTML por localidade | Page (sub-protocolo de Renderer) | .renderer(_:) |
| 5. Renderização do sistema | Renderer + RenderScope | .renderer(_:) |
| 6. Processamento da saída | OutputProcessor | .processor(_:) |
Para a fundamentação completa da arquitetura e exemplos práticos de cada ponto de extensão, leia references/architecture.md e references/custom-pages.md.
Veja também
Se uma tarefa não for coberta por nenhuma referência acima – você está modificando a própria biblioteca Swift do SiteKit em vez de construir um site com ele – encaminhe para a referência de contribuidor na raiz do repositório: AGENTS.md (detalhes internos do pipeline, protocolos de fase, pontos de troca do SiteBuilder, comandos de build e teste).
Para um índice tarefa → documento que abrange tanto a documentação voltada para humanos quanto estas referências, veja ../../../USE-CASES.md na raiz do repositório.