Documentation and Prototyping Workbench Tool for SvelteKit apps built with SvelteKit.
View the Kitbook used to document and build Kitbook itself
Kitbook Features
- File-based sidebar tree structure
- MDSvex (Markdown + Svelte Components) to enable easy documenation as you build
- Easy knobs allow for adjusting a component’s view state (special thanks @rixo’s Svench and Rich Harris’ svelte-knobby!)
- Quickly compare a single componenet across numerous different states
Examples
Example | Source | Playground |
---|---|---|
Kitbook’s Kitbook | GitHub | Play Online |
Kitbook Template (navigate to the simple example in a sub-route) | GitHub (in Kitbook monorepo) | Play Online |
Svelte Pieces Kitbook | GitHub (in Kitbook monorepo) | Play Online |
Living Dictionaries Kitbook | GitHub | Play Online |
SvelteFireTS Kitbook | GitHub | Play Online |
Contributing
Contributions are welcome! After cloning down the monorepo, with pnpm installed on your machine, run pnpm i
and pnpm dev
to get started.