A reusable SvelteKit docs template for launching branded documentation fast.
This repository provides a ready-to-use docs app with configurable SEO, navigation, interactive docs UI, OG image generation, and mdsvex content structure.
pnpm install
pnpm devApp runs in apps/web.
Update these files first:
apps/web/src/lib/config/site.ts- site name, description, keywords, links, package metadata, canonical URL.apps/web/src/lib/config/branding.ts- logo source and brand label used in shared UI.apps/web/src/lib/config/navigation.ts- manual sidebar structure and pages order.apps/web/src/lib/config/content-ui.ts- search, TOC, actions, pagination, package manager tabs, theme defaults.
Then adjust docs content:
apps/web/src/lib/content/**/*- page content (.svxor.svelte) and routes.
pnpm dev
pnpm check
pnpm lint
pnpm build
pnpm deploy:web- Command Palette focus: DOM focus remains on the search input while keyboard navigation updates the highlighted result and its accent indicator. The palette intentionally suppresses the standard component focus ring because it would compete with that selected-result treatment. Revisit this exception if the palette changes to move DOM focus between result items.
MIT. See LICENSE.