Skip to content

reepolee/kit-docs

This branch is up to date with svelteness/kit-docs:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7fdd1a6 Β· Sep 16, 2023
Apr 11, 2022
Sep 15, 2023
Apr 26, 2022
Sep 15, 2023
Sep 16, 2023
Apr 11, 2022
Apr 17, 2022
Apr 11, 2022
Jul 22, 2022
Apr 11, 2022
Sep 16, 2023
Apr 11, 2022
Mar 24, 2023
Sep 16, 2023
Sep 15, 2023
Apr 17, 2022
Apr 11, 2022
Apr 17, 2022

Repository files navigation

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 kitdocs.vercel.app.

❀️ 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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 49.8%
  • Svelte 26.3%
  • JavaScript 18.0%
  • CSS 5.4%
  • HTML 0.5%