@todesktop/kit-docs
TypeScript icon, indicating that this package has built-in type declarations

0.24.4 • Public • Published

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.

📝 License

KitDocs is MIT licensed.

Package Sidebar

Install

npm i @todesktop/kit-docs

Weekly Downloads

9

Version

0.24.4

License

MIT

Unpacked Size

1.43 MB

Total Files

100

Last publish

Collaborators

  • isaacaderogba
  • megahertz
  • davej