znarro / kit-docs

Documentation integration for SvelteKit.

Home Page:https://kit-docs.svelteness.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

KitDocs

package-badge

Documentation integration for SvelteKit. You can think of it as a VitePress alternative for Svelte.

Demo ScreenShot

✨ 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!

Powered by Vercel

πŸ“ License

KitDocs is MIT licensed.

About

Documentation integration for SvelteKit.

https://kit-docs.svelteness.dev

License:MIT License


Languages

Language:TypeScript 50.5%Language:Svelte 27.1%Language:JavaScript 17.5%Language:CSS 4.5%Language:HTML 0.5%