KitDocs
Documentation integration for SvelteKit. You can think of it as a VitePress alternative for Svelte.
β¨ Features
π Vite plugin for transforming Markdown files to Svelte components with HMR support.π‘ Loaders and endpoint handlers for loading Markdown metadata (i.e., title, frontmatter, etc.), and sidebar configurations.π¨ Beautiful pre-designed theme that's inspired by the Tailwind docs.βΏ Accessible menus and popovers with full keyboard support, which are included in the default theme and also exported for your convenience.π Global components folder that's imported into all Markdown files and also mapped to custom containers (e.g.,Button.svelte
->:::button
).𧩠Markdown extensions for header anchors, file links, YAML frontmatter, emojis, custom containers, table of contents, code fences, and importing code snippets.πΌοΈ Beautiful syntax highlighting with Shiki. This includes pre-designed code blocks that support titles, line highlighting, copy code button and a few other goodies.ποΈ Prebuilt Markdown components for steps, admonitions (i.e., callouts), tabbed links, responsive tables, and yes/no blocks.π Algolia search integration that includes a clean default design.
π Documentation
You can find our documentation at kit-docs.svelteness.dev.
β€οΈ Special Thanks
Thanks to Vercel for graciously providing us an OSS sponsored account for hosting our docs site!
π License
KitDocs is MIT licensed.