SveltePress/sveltepress

SvelteKit docs & blog SSG — Svelte 5 in Markdown, versioning, i18n, and Pagefind.

TypeScript

540

2,032 commits

updated Oct 11, 2026

See the code

README


Sveltepress
Sveltepress

SvelteKit docs & blog SSG — write Markdown, keep the full power of SvelteKit.
Svelte 5 Runes in Markdown · document versioning · i18n · Pagefind / DocSearch

Docs npm npm downloads GitHub stars MIT

https://github.com/user-attachments/assets/39669b6a-61bc-4701-93d8-fe98b88a58cb

Sveltepress screenshots

Sveltepress lighthouse

Not affiliated with the archived GeopJr/SveltePress.

Why 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-blog for 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.

Comparison

Feature / AspectSveltepressVitePressAstro (Starlight)Docusaurus
EcosystemSvelte / SvelteKitVue 3Framework-agnosticReact
Build EngineVite 8 + SvelteKit 2/3Vite + Vue 3Vite + Astro compilerWebpack
Fullstack PowerFull SvelteKit surface (SSR, API routes, hooks)Static-focused SSGRequires SSR adapterRequires Node plugins
ReactivitySvelte 5 Runes natively in .mdVue 3 Composition APIStatic by default (Islands)React Hooks
Interactive CodeNative live components + Twoslash hoverVue componentsRequires pluginsRequires react-live
Doc VersioningContent-addressed immutable deltas & diffsBranch/dir-basedRequires pluginsDirectory snapshot copies
SearchPagefind (built-in) / DocSearch / MeilisearchPagefind / DocSearchPagefindAlgolia / local plugins
AI Knowledge (llms.txt)Built-in automatic generationThird-party pluginThird-party pluginThird-party plugin

Quick start

npm create @sveltepress@latest

Docs: sveltepress.site · Blog theme: getting started

Packages

PackagePurpose
@sveltepress/createInteractive scaffolder for JavaScript and TypeScript Sveltepress sites
@sveltepress/cliVersion manifest, documentation snapshot, and validation CLI
@sveltepress/viteCore Vite and SvelteKit integration, Markdown pipeline, and version routing
@sveltepress/theme-defaultDefault documentation theme with navigation, search, and content features
@sveltepress/theme-blogStatic magazine-style blog theme with posts, pagination, RSS, OG images, and Pagefind
@sveltepress/twoslashTypeScript and Svelte hover information for Shiki code blocks
@sveltepress/docsearchAlgolia DocSearch UI component for Sveltepress themes
@sveltepress/meilisearchMeilisearch search UI integration for Sveltepress themes

Contributing

All kinds of contributions are welcome. See Contributing.

Thanks

This project would not exist without:

Who's using

Using Sveltepress? Open a PR or comment on #334 and we'll add you.

LICENSE

MIT

blog
blogging
docs
documentation
i18n
markdown
pagefind
pwa
ssg
static-site-generator
svelte
svelte5
sveltekit
theme
vite

SveltePress/sveltepress

SvelteKit docs & blog SSG — Svelte 5 in Markdown, versioning, i18n, and Pagefind.

TypeScript

540

2,032 commits

updated Oct 11, 2026

See the code

README


Sveltepress
Sveltepress

SvelteKit docs & blog SSG — write Markdown, keep the full power of SvelteKit.
Svelte 5 Runes in Markdown · document versioning · i18n · Pagefind / DocSearch

Docs npm npm downloads GitHub stars MIT

https://github.com/user-attachments/assets/39669b6a-61bc-4701-93d8-fe98b88a58cb

Sveltepress screenshots

Sveltepress lighthouse

Not affiliated with the archived GeopJr/SveltePress.

Why 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-blog for 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.

Comparison

Feature / AspectSveltepressVitePressAstro (Starlight)Docusaurus
EcosystemSvelte / SvelteKitVue 3Framework-agnosticReact
Build EngineVite 8 + SvelteKit 2/3Vite + Vue 3Vite + Astro compilerWebpack
Fullstack PowerFull SvelteKit surface (SSR, API routes, hooks)Static-focused SSGRequires SSR adapterRequires Node plugins
ReactivitySvelte 5 Runes natively in .mdVue 3 Composition APIStatic by default (Islands)React Hooks
Interactive CodeNative live components + Twoslash hoverVue componentsRequires pluginsRequires react-live
Doc VersioningContent-addressed immutable deltas & diffsBranch/dir-basedRequires pluginsDirectory snapshot copies
SearchPagefind (built-in) / DocSearch / MeilisearchPagefind / DocSearchPagefindAlgolia / local plugins
AI Knowledge (llms.txt)Built-in automatic generationThird-party pluginThird-party pluginThird-party plugin

Quick start

npm create @sveltepress@latest

Docs: sveltepress.site · Blog theme: getting started

Packages

PackagePurpose
@sveltepress/createInteractive scaffolder for JavaScript and TypeScript Sveltepress sites
@sveltepress/cliVersion manifest, documentation snapshot, and validation CLI
@sveltepress/viteCore Vite and SvelteKit integration, Markdown pipeline, and version routing
@sveltepress/theme-defaultDefault documentation theme with navigation, search, and content features
@sveltepress/theme-blogStatic magazine-style blog theme with posts, pagination, RSS, OG images, and Pagefind
@sveltepress/twoslashTypeScript and Svelte hover information for Shiki code blocks
@sveltepress/docsearchAlgolia DocSearch UI component for Sveltepress themes
@sveltepress/meilisearchMeilisearch search UI integration for Sveltepress themes

Contributing

All kinds of contributions are welcome. See Contributing.

Thanks

This project would not exist without:

Who's using

Using Sveltepress? Open a PR or comment on #334 and we'll add you.

LICENSE

MIT

blog
blogging
docs
documentation
i18n
markdown
pagefind
pwa
ssg
static-site-generator
svelte
svelte5
sveltekit
theme
vite

Significant stargazers

Vincent Esche

223 followers · starred Mar 2025

迷渡

17,309 followers · starred Mar 2024

Joseph Kato

306 followers · starred May 2023

Hunter Johnston

1,932 followers · starred Jun 2023