SvelteDocs

SvelteDocs is the documentation starter the Svelte ecosystem has been asking for. While Astro has Starlight and Next.js has Nextra, SvelteKit developers have been cobbling together doc sites from blog starters and generic templates. SvelteDocs changes that with a purpose-built documentation framework that understands what developer docs need.

The content pipeline is markdown-first. Drop .md or .mdx files into the docs directory, and SvelteDocs generates the sidebar, breadcrumbs, previous/next navigation, and table of contents automatically from your file and folder structure. Frontmatter controls page titles, ordering, and visibility, but the defaults are smart enough that most pages need zero configuration.

What stands out

Search. Powered by Pagefind, the search index is built at deploy time and runs entirely in the browser — no Algolia account, no API keys, no external dependencies. Results are fast and accurate, with content previews and section-level linking. For a free, self-hosted solution, it rivals commercial alternatives.

The code block experience is polished. Shiki handles syntax highlighting with proper theme support (including matching your site’s light/dark mode). Code blocks include copy buttons, line number toggles, line highlighting for callouts, and file name headers. You can embed live Svelte components alongside code examples, which is invaluable for component library documentation.

Version support is a standout feature. A dropdown in the header lets readers switch between documentation versions (v1, v2, etc.), and the URL structure cleanly separates versioned content.

Where it could improve

The versioning system works but scales poorly. Each version is a full copy of the docs directory, which means updating shared content across versions requires manual duplication. A content inheritance model — where pages default to the latest version unless overridden — would be a significant improvement.

No internationalization support. For projects with a global contributor base, translating docs is a common need, and there’s no built-in workflow for managing translations.

On large documentation sites (500+ pages), the Pagefind index rebuild can add noticeable time to the build step. This is a Pagefind limitation rather than a SvelteDocs issue, but it’s worth knowing before committing to the stack for a massive documentation project.