KitBook

Documentation and Prototyping Workbench Tool for Svelte built with SvelteKit that lets you rapidly build, document, and test components. Most similar to Svench, but also with goodies inspired by [others].

Features

• File-based sidebar tree structure, with optional prefixed numbers to adjust ordering of your docs
• Iframe isolation for easy media query testing
• Stories load via SSR first and then are hydrated on Client
• MDSvex (Markdown + Svelte Components) to enable easy documenation as you build
• Easy knobs allow for adjusting a component’s state (special thanks to @rixo’s Svench)
• Quickly create and compare numerous variants of a component via an array of auto-typed prop objects in a colocated typescript file that can also be used for testing.
• All SvelteKit-only imports are automatically avaiable because it’s a SvelteKit app.
• Build components using the same initialization hooks as your main unless you turn them off i18n
• Foam based automatic updating wiki-links for easy linking within your Kitbook.

Start Documenting and Prototyping Components

[Get Started: How to Create a KitBook] or view some [Examples] - spoiler alert: you’re looking at one already