@kachurun/storybook-solid-template
v10.0.3
Published
**Note:** _This is a template used by the [`create-solid-storybook`](https://github.com/kachurun/create-solid-storybook) CLI to scaffold Storybook in your SolidJS project. It is not intended for direct use._
Readme
SolidJS Storybook Template
Note: This is a template used by the create-solid-storybook CLI to scaffold Storybook in your SolidJS project. It is not intended for direct use.
This template provides a ready-to-use Storybook setup for SolidJS, designed to help you quickly document, develop, and test your UI components.
Features
- ⚡️ Pre-configured Storybook for SolidJS
- 🧩 Example stories and components
- 📁 Recommended directory structure
- 🔗 Easy integration with your SolidJS app
- 📖 Interactive documentation with MDX and Docs addon
- ♿️ Accessibility checks with A11y addon
- 🔗 Component linking with Links addon
- 🚀 Onboarding experience with Onboarding addon
- 🧪 Integrated component testing with Vitest addon
- 📝 Automatic documentation with Autodocs addon
How to Use
If you're reading this, you likely already have this template in your project—either by running the create-solid-storybook CLI or by copying this folder manually.
Tip: For the best experience and up-to-date configuration, we recommend using the CLI to scaffold Storybook in your SolidJS project.
1. Install Dependencies
Install the required dependencies:
npm install
# or
bun install2. Run Storybook
Start Storybook locally:
npm run storybook
# or
bun run storybookOpen the provided URL in your browser to view your Storybook instance.
3. Explore and Customize
- Browse the example stories in the
stories/directory. - Add your own components and stories to the
stories/directory. - Update
.storybook/configuration files as needed for your project.
Directory Structure
.storybook/– Storybook configuration filesstories/– Example stories and components
Learn More
Contributing
Contributions and feedback are welcome! Please open an issue or submit a pull request via the create-solid-storybook repository.
👤 Maintainer
Maintained with ❤️ by @kachurun
📖 License
MIT
