Quick Start

svedocs is a SvelteKit-native documentation framework for docs sites that want a single, integrated stack: content loading, theme, search, Ask AI, SEO, OG images, and Cloudflare deployment helpers.

Install#

Shell
1pnpm add svedocs
2pnpm add -D svedocs-cli

Create a site#

Shell
1pnpm create svedocs my-docs
2cd my-docs
3pnpm install
4pnpm dev

What you get#

Capability	Default
Content	Markdown, SVX/MDX-style authoring, frontmatter, code metadata, and scoped navigation
Theme	Tailwind CSS v4 theme tokens, light and dark modes, and layout components
Deploy	Cloudflare edge SSR, static output, and SPA fallback
Search	Local MiniSearch, Algolia, Typesense, and Cloudflare AI Search
Ask AI	Mock, Cloudflare AI Search, Workers AI, OpenAI-compatible providers, citations, and rate limits
SEO	Metadata, JSON-LD, sitemap, robots, and OG assets

Next steps#

• Read Installation if you are wiring svedocs into an existing SvelteKit app.
• Read Writing to understand the content model and authoring flow.
• Read Configuration for site metadata, theme, and build settings.
• Read Integrations for search, AI, deployment, and SEO helpers.

FAQ#

• New project? Use pnpm create svedocs.
• Existing project? Start with pnpm add svedocs and pnpm add -D svedocs-cli.
• Need a quick demo? The CLI can scaffold a full docs site with local search and OG routes.