"I want to do X → go here." A fast lookup for everyone – new users, AI agents, and contributors.
This is the index, not the explanation. For a guided walkthrough read README.md; if you're an AI agent driving SiteKit, SKILL.md routes every task to the right reference. Where a task has both a human entry point and a deeper reference, both are listed.
| I want to… | Go to |
|---|---|
| Decide whether SiteKit fits my project | README – Is SiteKit for you? |
| Pick a blueprint | Blueprint catalog · deep: blueprints.md |
| Install SiteKit + scaffold my first site | README – Get started · deep: bootstrap.md |
| Set up a new site end-to-end (the judgment-heavy flow) | onboarding.md |
| Build a documentation site from a DocC catalog | DocC blueprint · deep: markdown-extensions.md |
| I want to… | Go to |
|---|---|
| Write posts, newsletter issues, or static pages | content-writing.md |
| Configure site metadata (name, URL, navigation, author) | siteconfig-reference.md |
Use DocC / Markdown directives (@Metadata, @Row, @TabNavigator, @Video, …) |
markdown-extensions.md |
Configure the DocC home page, appbar, sidebar, and search (the docc: block) |
siteconfig-reference.md – docc |
| Decide whether you need an imprint / privacy page (per country) | legal-pages.md |
| Add legal pages (German example templates) | Imprint template · Privacy Policy template |
| I want to… | Go to |
|---|---|
| Change colors, fonts, or layout | README – Customise the look · deep: themes.md |
| Make the site multi-language | localization.md |
| Audit accessibility (WCAG AA, alt text, keyboard nav) | accessibility.md |
| Improve SEO / ASO / AI-discoverability | seo-aso.md |
| Improve performance / PageSpeed (LCP, CLS, render-blocking) | performance.md |
| I want to… | Go to |
|---|---|
| Deploy to Cloudflare Pages (canonical, free) | cloudflare-pages.md |
| Deploy elsewhere or set up CI | deployment – start here |
| Run a self-hosted newsletter (Keila + SMTP) | newsletter-setup.md |
| Choose external services (email sending, integrations) | external-services.md |
| Fix a failing build | README – When something goes wrong · deep: troubleshooting.md |
| I want to… | Go to |
|---|---|
Add a custom Page (a new HTML page type) |
custom-pages.md |
| Extend the build pipeline (Loader / Enricher / Renderer / OutputProcessor / Teleporter) | architecture.md · AGENTS.md |
| Drive SiteKit with another AI tool (Copilot, Codex, Gemini, …) | Cross-Tool-Guide.md |
| I want to… | Go to |
|---|---|
| Understand SiteKit's architecture / contribute to it | AGENTS.md |
| Update a site to a newer SiteKit version | bootstrap.md – sitekit update |
| (AI agent) Route any task to the right reference | SKILL.md |