Giter VIP home page Giter VIP logo

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.

Svelteness's Projects

kit-docs icon kit-docs

Documentation integration for SvelteKit.

svelte-jester icon svelte-jester

A Jest transformer for Svelte - compile your components before importing them into tests.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.