Skip to content

Commit

Permalink
docs: add features and inspiration by Histoire (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasdiez committed Mar 10, 2023
1 parent 80e1b63 commit 7089e3c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -42,10 +42,18 @@ import Button from './Button.vue'

## Features

- Write stories as idiomatic Vue templates, bye bye string-based templates, as wished for in [storybookjs/storybook#9768](https://github.com/storybookjs/storybook/issues/9768)
- Syntax highlighting and full editor support (including Volar) for writing story templates
- The component that is displayed needs only be declared once (via `<Stories :component="...">`) and not for every story
- Simple integration with Storybook and automatic Vite support
- Light: Vue stories are transpiled into ordinary CSF stories on the fly with minimal overhead

This package is currently in an early alpha stage and supports only the fundamental Storybook features.
Compatibility with more advanced features and addons is work in progress.
Please open an issue if you encounter any bugs or missing integrations.

The way to write stories as idiomatic Vue templates is heavily inspired by the great [Histoire](https://histoire.dev/).

## Installation

> Note: Currently, only the [vite storybook builder](https://github.com/storybookjs/builder-vite) is supported and `@storybook/builder-vite` version 0.2.7 or higher is required.
Expand Down

0 comments on commit 7089e3c

Please sign in to comment.