Skip to content

Commit

Permalink
Merge pull request #17401 from storybookjs/fix_addon_support_table
Browse files Browse the repository at this point in the history
Chore: (Docs) Removes outdated support table and updates links
  • Loading branch information
shilman committed Feb 12, 2022
1 parent 2d370a7 commit f43e322
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 51 deletions.
32 changes: 0 additions & 32 deletions ADDONS_SUPPORT.md

This file was deleted.

2 changes: 1 addition & 1 deletion addons/a11y/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This Storybook addon can be helpful to make your UI components more accessible.

[Framework Support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md)
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)

![Screenshot](https://raw.githubusercontent.com/storybookjs/storybook/next/addons/a11y/docs/screenshot.png)

Expand Down
17 changes: 4 additions & 13 deletions addons/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,19 +77,10 @@ For more information on `MDX`, see the [`MDX` reference](https://github.com/stor

## Framework support

Storybook Docs supports all view layers that Storybook supports except for React Native (currently). There are some framework-specific features as well, such as props tables and inline story rendering. This chart captures the current state of support:

| | React | Vue | Angular | Ember | Web Components | Marko | HTML | Svelte | Preact | Riot | Mithril | Marko |
| ----------------- | :---: | :-: | :-----: | :---: | :------------: | :---: | :--: | :----: | :----: | :--: | :-----: | :---: |
| MDX stories | + | + | + | + | + | WIP | + | + | + | + | + | + |
| CSF stories | + | + | + | + | + | WIP | + | + | + | + | + | + |
| StoriesOf stories | + | + | + | + | + | WIP | + | + | + | + | + | + |
| Source | + | + | + | + | + | WIP | + | + | + | + | + | + |
| Notes / Info | + | + | + | + | + | WIP | + | + | + | + | + | + |
| Props table | + | + | + | + | + | WIP | | | | | | |
| Props controls | + | + | + | | | WIP | | | | | | |
| Description | + | + | + | + | + | WIP | | | | | | |
| Inline stories | + | + | + | | + | WIP | + | | | | | |
Storybook Docs supports all view layers that Storybook supports except for React Native (currently). There are some framework-specific features as well, such as props tables and inline story rendering. The following page captures the current state of support:

[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)


**Note:** `#` = WIP support

Expand Down
2 changes: 1 addition & 1 deletion addons/essentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Storybook Essentials is a curated collection of addons to bring out the best of Storybook.

Each addon is documented and maintained by the core team and will be upgraded alongside Storybook as the platform evolves. We will also do our best to maintain [framework support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md) for all of the officially supported frameworks.
Each addon is documented and maintained by the core team and will be upgraded alongside Storybook as the platform evolves. We will also do our best to maintain [framework support](https://storybook.js.org/docs/react/api/frameworks-feature-support) for all of the officially supported frameworks.

## Contents

Expand Down
2 changes: 1 addition & 1 deletion addons/jest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Storybook addon for inspecting Jest unit test results.

[Framework Support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md)
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)

[![Storybook Jest Addon Demo](https://raw.githubusercontent.com/storybookjs/storybook/next/addons/jest/docs/storybook-addon-jest.gif)](http://storybooks-official.netlify.com/?selectedKind=Addons%7Cjest&selectedStory=withTests&full=0&addons=1&stories=1&panelRight=0&addonPanel=storybook%2Ftests%2Fpanel)

Expand Down
2 changes: 1 addition & 1 deletion addons/links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Storybook Links addon can be used to create links that navigate between stories in [Storybook](https://storybook.js.org).

[Framework Support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md)
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)

## Getting Started

Expand Down
2 changes: 1 addition & 1 deletion addons/storyshots/storyshots-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybook.js.org/).

[Framework Support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md)
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)

![StoryShots In Action](https://raw.githubusercontent.com/storybookjs/storybook/HEAD/addons/storyshots/storyshots-core/docs/storyshots-fail.png)

Expand Down
2 changes: 1 addition & 1 deletion addons/storysource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This addon is used to show stories source in the addon panel.

[Framework Support](https://github.com/storybookjs/storybook/blob/main/ADDONS_SUPPORT.md)
[Framework Support](https://storybook.js.org/docs/react/api/frameworks-feature-support)

![Storysource Demo](https://raw.githubusercontent.com/storybookjs/storybook/next/addons/storysource/docs/demo.gif)

Expand Down

0 comments on commit f43e322

Please sign in to comment.