sveltebook

A Storybook alternative made with <3 and Svelte.

[!WARNING] This project is in early development, and it is not ready for production yet. We are working hard to make it ready for you to use, but it will take some time.

[!NOTE] We are actively looking for contributors to help us build this project. If you are interested, please let us know.

Why?

Storybook is a great tool, but it is writting in React. Lots of efforts have been spend bending Storybook to work with Svelte, but it is not the same. Sveltebook is a Storybook alternative made with Svelte, for Svelte.

It allows you to document your components, create stories, and test them in isolation - with all the Svelte features you know and love.

Features

• Create stories for your Svelte components
• Use all the Svelte features in your stories
• Write stories and documentation in Svelte or Markdown with mdsvex
• Include your components in Sveltebook like you would in your app
• No need to learn Storybook - use the tools you already know
• Add Storybook to your project with a single command

Getting started

TODO

Contributing

Feel free to contribute to this project. We are looking for help with the following:

• Documentation
• Testing
• Code contributions
• Feature requests
• Bug reports
• Anything else you can think of

Roadmap

• Testing stories: Define sensible defaults for testing stories.
• Svelte Composer: Allow users to add sveltebook to their project with a single command and help them getting started.