Sveltepress

A content centered site build tool

:pizza: Introduction

Inspired by Vitepress Build with SvelteKit

Sveltepress supports Svelte 5, SvelteKit 2, and Vite 8. Use Node.js ^20.19.0 or >=22.12.0.

:rocket: Quick start

npm create @sveltepress@latest

The generated project uses the default documentation theme. For an editorial site with posts, pagination, RSS, Open Graph images, and Pagefind search, follow the blog theme guide.

:package: Packages

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

:bookmark_tabs: Online docs and demos

Sveltepress

:pray: Contributing

First of all, all kinds of contributions are welcomed!

For contributing details, see Contributing

:heart: Thanks

This project can not be done without these projects

• Vitepress
• SvelteKit
• Svelte
• Vitest
• Vite
• Unocss
• Shiki
• Remark
• Rehype
• Vite PWA

Who's using

LICENSE

MIT