mirror of
https://github.com/storybookjs/storybook.git
synced 2025-03-17 05:02:23 +08:00
FIX spelling
This commit is contained in:
parent
d41142d5ba
commit
79d9838c73
17
.spelling
Normal file
17
.spelling
Normal file
@ -0,0 +1,17 @@
|
||||
# markdown-spellcheck spelling configuration file
|
||||
# Format - lines beginning # are comments
|
||||
# global dictionary is at the start, file overrides afterwards
|
||||
# one word per line, to define a file override use ' - filename'
|
||||
# where filename is relative to this configuration file
|
||||
addon
|
||||
1
|
||||
vue
|
||||
webcomponents
|
||||
aurelia
|
||||
iframe
|
||||
webpack
|
||||
addons
|
||||
styleguide-type
|
||||
styleguides
|
||||
angularjs
|
||||
api
|
30
ROADMAP.md
30
ROADMAP.md
@ -3,12 +3,12 @@
|
||||
## Table of contents
|
||||
|
||||
- [New features](#new-features)
|
||||
- [Responsive + multidevice viewports preview.](#responsive--multidevice-viewports-preview)
|
||||
- [Responsive + multi-device viewports preview.](#responsive--multidevice-viewports-preview)
|
||||
- [Automatic story detection](#automatic-story-detection)
|
||||
- [Theme ability and override core UI components](#theme-ability-and-override-core-ui-components)
|
||||
- [Add a playground addon](#add-a-playground-addon)
|
||||
- [See multiple (or all) stories in 1 preview.](#see-multiple-or-all-stories-in-1-preview)
|
||||
- [Deeper level hierachy](#deeper-level-hierachy)
|
||||
- [Deeper level hierarchy](#deeper-level-hierachy)
|
||||
- [Supporting other frameworks and libraries](#supporting-other-frameworks-and-libraries)
|
||||
- [Vue](#vue)
|
||||
- [Angular](#angular)
|
||||
@ -21,13 +21,13 @@
|
||||
- [Documentation](#documentation)
|
||||
- [Search & Structure](#search--structure)
|
||||
- [Better design](#better-design)
|
||||
- [Record videos and write blogpost on how to tweak storybook](#record-videos-and-write-blogpost-on-how-to-tweak-storybook)
|
||||
- [Record videos and write blog post on how to tweak storybook](#record-videos-and-write-blogpost-on-how-to-tweak-storybook)
|
||||
|
||||
## New features
|
||||
|
||||
Doing these will be backwards compatible.
|
||||
|
||||
### Responsive + multidevice viewports preview.
|
||||
### Responsive + multi-device viewports preview.
|
||||
|
||||
If you're smart about it you can already view the preview on multiple devices and windows. It's just an iframe after-all.
|
||||
But story selection and addon-settings are not synced.
|
||||
@ -41,27 +41,27 @@ We think such a feature is highly needed. A lot of users are already hacking thi
|
||||
### Theme ability and override core UI components
|
||||
|
||||
Storybook is often used inside product companies and agencies. We want to help them have a sense of quality and immersion.
|
||||
We're interested in full constimizability of our UI, though addons and options.
|
||||
We're interested in full customizability of our UI, though addons and options.
|
||||
|
||||
### Add a playground addon
|
||||
|
||||
Many other styleguide-type projects have what's called a playground, where developers can change the code rendering the component inside the app.
|
||||
Storybook has ofcourse a very tight connection with your editor, and it has a knobs addon.
|
||||
Storybook has of course a very tight connection with your editor, and it has a knobs addon.
|
||||
But we still see value in an addon that will allow the workflow of a playground.
|
||||
|
||||
### See multiple (or all) stories in 1 preview.
|
||||
|
||||
Storybook's philosophy is about describing small bits in a variaty of states.
|
||||
However some components are best understood when viewed in multiple variaties in 1 view.
|
||||
Storybook's philosophy is about describing small bits in a variety of states.
|
||||
However some components are best understood when viewed in multiple varieties in 1 view.
|
||||
It's quite common to see users write a single story, with a wrapper components and multiple instances of the component the story is about.
|
||||
We plan to add a second mode to storybook that will allow you to see all stories in 1 preview.
|
||||
That way you can write your stories how they are best, and preview them how you like.
|
||||
|
||||
### Deeper level hierachy
|
||||
### Deeper level hierarchy
|
||||
|
||||
A very long standing issue is about "what about larger styleguides?". Some stylguides have lots and lots of components.
|
||||
A very long standing issue is about "what about larger styleguides?". Some styleguides have lots and lots of components.
|
||||
At some point is becomes unmaintainable if you do not group them somehow.
|
||||
Storybook's UI is not exaclty setup for very large styleguides, right now.
|
||||
Storybook's UI is not exactly setup for very large styleguides, right now.
|
||||
But we are going to add a way of defining groups! And develop a UI that allows you to quickly navigate to other groups / stories.
|
||||
|
||||
## Supporting other frameworks and libraries
|
||||
@ -96,7 +96,7 @@ Please contact us if you want this.
|
||||
|
||||
### Addon API
|
||||
|
||||
Our addon api is limited and will eventually have to be improved to acommodate better more optimized and modern addons.
|
||||
Our addon api is limited and will eventually have to be improved to accommodate better more optimized and modern addons.
|
||||
|
||||
### API for adding stories
|
||||
|
||||
@ -108,13 +108,13 @@ We want to support this, but will likely mean we will have to change the `add` m
|
||||
### Search & Structure
|
||||
|
||||
Finding the right part of our documentation isn't easy, since there is no search.
|
||||
We want to intergrate the readme of the individual packages into the documentation site and also have the changelog, contributing, migration and roadmap findable there.
|
||||
We want to integrate the readme of the individual packages into the documentation site and also have the changelog, contributing, migration and roadmap findable there.
|
||||
|
||||
### Better design
|
||||
|
||||
We have a new logo, so next step is a overheal of our documentation site.
|
||||
We have a new logo, so next step is a overhaul of our documentation site.
|
||||
|
||||
### Record videos and write blogpost on how to tweak storybook
|
||||
### Record videos and write blog post on how to tweak storybook
|
||||
|
||||
This may include writing addons, choosing the right addons etc.
|
||||
Also how to start developing on our codebase.
|
||||
|
Loading…
x
Reference in New Issue
Block a user