SvelteKit docs & blog SSG — write Markdown, keep the full power of SvelteKit.
Svelte 5 Runes in Markdown · document versioning · i18n · Pagefind / DocSearch
sveltepress-promo-github.mp4
Not affiliated with the archived GeopJr/SveltePress.
Inspired by VitePress, built on SvelteKit — so you get a docs/blog toolkit and the full SvelteKit surface (SSR, adapters, server routes, hooks).
- Svelte 5 in Markdown — Runes, components, and interactive islands inside
.md - Immutable doc versioning — clean current URLs plus historical snapshots
- Search that works — Pagefind by default; DocSearch / Meilisearch when you need them
- i18n built in — locales, switcher, version-aware navigation
- Docs + blog themes — default docs theme, or
theme-blogfor posts, RSS, OG images
Requires Svelte 5, SvelteKit 2 (2.65.1+) or 3, Vite 8, and Node.js ^20.19.0 or >=22.12.0.
| Feature / Aspect | Sveltepress | VitePress | Astro (Starlight) | Docusaurus |
|---|---|---|---|---|
| Ecosystem | Svelte / SvelteKit | Vue 3 | Framework-agnostic | React |
| Build Engine | Vite 8 + SvelteKit 2/3 | Vite + Vue 3 | Vite + Astro compiler | Webpack |
| Fullstack Power | Full SvelteKit surface (SSR, API routes, hooks) | Static-focused SSG | Requires SSR adapter | Requires Node plugins |
| Reactivity | Svelte 5 Runes natively in .md |
Vue 3 Composition API | Static by default (Islands) | React Hooks |
| Interactive Code | Native live components + Twoslash hover | Vue components | Requires plugins | Requires react-live |
| Doc Versioning | Content-addressed immutable deltas & diffs | Branch/dir-based | Requires plugins | Directory snapshot copies |
| Search | Pagefind (built-in) / DocSearch / Meilisearch | Pagefind / DocSearch | Pagefind | Algolia / local plugins |
AI Knowledge (llms.txt) |
Built-in automatic generation | Third-party plugin | Third-party plugin | Third-party plugin |
npm create @sveltepress@latestDocs: sveltepress.site · Blog theme: getting started
| Package | Purpose |
|---|---|
@sveltepress/create |
Interactive scaffolder for JavaScript and TypeScript Sveltepress sites |
@sveltepress/cli |
Version manifest, documentation snapshot, and validation CLI |
@sveltepress/vite |
Core Vite and SvelteKit integration, Markdown pipeline, and version routing |
@sveltepress/theme-default |
Default documentation theme with navigation, search, and content features |
@sveltepress/theme-blog |
Static magazine-style blog theme with posts, pagination, RSS, OG images, and Pagefind |
@sveltepress/twoslash |
TypeScript and Svelte hover information for Shiki code blocks |
@sveltepress/docsearch |
Algolia DocSearch UI component for Sveltepress themes |
@sveltepress/meilisearch |
Meilisearch search UI integration for Sveltepress themes |
All kinds of contributions are welcome. See Contributing.
This project would not exist without:
Using Sveltepress? Open a PR or comment on #334 and we'll add you.