mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-04 13:01:07 +08:00
Merge pull request #18818 from storybookjs/chore_docs_updates_docs_urls_for_code
Update docs with restructured monorepo links
This commit is contained in:
Michael Shilman
GitHub
commit
8346f4ab74
50
README.md
50
README.md
@ -93,46 +93,46 @@ For additional help, join us in the [Storybook Discord](https://discord.gg/story
|
||||
|
||||
### Supported Frameworks
|
||||
|
||||
| Framework | Demo | |
|
||||
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [React](app/react) | [](https://storybookjs.netlify.com/official-storybook/?path=/story/*) | [](app/react) |
|
||||
| [Vue](app/vue) | [](https://storybookjs.netlify.com/vue-kitchen-sink/) | [](app/vue) |
|
||||
| [Angular](app/angular) | [](https://storybookjs.netlify.com/angular-cli/) | [](app/angular) |
|
||||
| [Web components](app/web-components) | [](https://storybookjs.netlify.com/web-components-kitchen-sink/) | [](app/web-components) |
|
||||
| Renderer | Demo | |
|
||||
|----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [React](code/renderers/react) | [](https://storybookjs.netlify.com/official-storybook/?path=/story/*) | [](code/renderers/react) |
|
||||
| [Vue](code/renderers/vue) | [](https://storybookjs.netlify.com/vue-kitchen-sink/) | [](code/renderers/vue) |
|
||||
| [Angular](code/frameworks/angular/) | [](https://storybookjs.netlify.com/angular-cli/) | [](code/frameworks/angular/) |
|
||||
| [Web components](code/renderers/web-components) | [](https://storybookjs.netlify.com/web-components-kitchen-sink/) | [](code/renderers/web-components) |
|
||||
| [React Native](https://github.com/storybookjs/react-native) | - | [](https://github.com/storybookjs/react-native) |
|
||||
| [HTML](app/html) | [](https://storybookjs.netlify.com/html-kitchen-sink/) | [](app/html) |
|
||||
| [Ember](app/ember) | [](https://storybookjs.netlify.com/ember-cli/) | [](app/ember) |
|
||||
| [Svelte](app/svelte) | [](https://storybookjs.netlify.com/svelte-kitchen-sink/) | [](app/svelte) |
|
||||
| [Preact](app/preact) | [](https://storybookjs.netlify.com/preact-kitchen-sink/) | [](app/preact) |
|
||||
| [HTML](code/renderers/html) | [](https://storybookjs.netlify.com/html-kitchen-sink/) | [](code/renderers/html) |
|
||||
| [Ember](code/frameworks/ember/) | [](https://storybookjs.netlify.com/ember-cli/) | [](code/frameworks/ember/) |
|
||||
| [Svelte](code/renderers/svelte) | [](https://storybookjs.netlify.com/svelte-kitchen-sink/) | [](code/renderers/svelte) |
|
||||
| [Preact](code/renderers/preact) | [](https://storybookjs.netlify.com/preact-kitchen-sink/) | [](code/renderers/preact) |
|
||||
| [Marionette.js](https://github.com/storybookjs/marionette) | - | [](https://github.com/storybookjs/marionette) |
|
||||
| [Android, iOS, Flutter](https://github.com/storybookjs/native) | [](https://storybookjs.github.io/native/@storybook/native-flutter-example/index.html) | [](https://github.com/storybookjs/native) |
|
||||
|
||||
### Sub Projects
|
||||
|
||||
- [CLI](lib/cli) - Streamlined installation for a variety of app types
|
||||
- [examples](examples) - Code examples to illustrate different Storybook use cases
|
||||
- [CLI](code/lib/cli) - Streamlined installation for a variety of app types
|
||||
- [examples](code/examples) - Code examples to illustrate different Storybook use cases
|
||||
|
||||
### Addons
|
||||
|
||||
| Addons | |
|
||||
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| [a11y](addons/a11y/) | Test components for user accessibility in Storybook |
|
||||
| [actions](addons/actions/) | Log actions as users interact with components in the Storybook UI |
|
||||
| [backgrounds](addons/backgrounds/) | Let users choose backgrounds in the Storybook UI |
|
||||
| [a11y](code/addons/a11y/) | Test components for user accessibility in Storybook |
|
||||
| [actions](code/addons/actions/) | Log actions as users interact with components in the Storybook UI |
|
||||
| [backgrounds](code/addons/backgrounds/) | Let users choose backgrounds in the Storybook UI |
|
||||
| [cssresources](https://github.com/storybookjs/addon-cssresources) | Dynamically add/remove css resources to the component iframe |
|
||||
| [design assets](https://github.com/storybookjs/addon-design-assets) | View images, videos, weblinks alongside your story |
|
||||
| [docs](addons/docs/) | Add high quality documentation to your components |
|
||||
| [docs](code/addons/docs/) | Add high quality documentation to your components |
|
||||
| [events](https://github.com/storybookjs/addon-events) | Interactively fire events to components that respond to EventEmitter |
|
||||
| [google-analytics](https://github.com/storybookjs/addon-google-analytics) | Reports google analytics on stories |
|
||||
| [graphql](https://github.com/storybookjs/addon-graphql) | Query a GraphQL server within Storybook stories |
|
||||
| [jest](addons/jest/) | View the results of components' unit tests in Storybook |
|
||||
| [links](addons/links/) | Create links between stories |
|
||||
| [jest](code/addons/jest/) | View the results of components' unit tests in Storybook |
|
||||
| [links](code/addons/links/) | Create links between stories |
|
||||
| [query params](https://github.com/storybookjs/addon-queryparams) | Mock query params |
|
||||
| [storyshots](addons/storyshots/) | Snapshot testing for components in Storybook |
|
||||
| [storysource](addons/storysource/) | View the code of your stories within the Storybook UI |
|
||||
| [viewport](addons/viewport/) | Change display sizes and layouts for responsive components using Storybook |
|
||||
| [outline](addons/outline/) | Visuallly debug the CSS layout and alignment within the Storybook UI |
|
||||
| [measure](addons/measure/) | Visually inspect the layout and box model within the Storybook UI |
|
||||
| [storyshots](code/addons/storyshots/) | Snapshot testing for components in Storybook |
|
||||
| [storysource](code/addons/storysource/) | View the code of your stories within the Storybook UI |
|
||||
| [viewport](code/addons/viewport/) | Change display sizes and layouts for responsive components using Storybook |
|
||||
| [outline](code/addons/outline/) | Visuallly debug the CSS layout and alignment within the Storybook UI |
|
||||
| [measure](code/addons/measure/) | Visually inspect the layout and box model within the Storybook UI |
|
||||
|
||||
See [Addon / Framework Support Table](https://storybook.js.org/docs/react/api/frameworks-feature-support)
|
||||
|
||||
@ -148,9 +148,9 @@ See [Addon / Framework Support Table](https://storybook.js.org/docs/react/api/fr
|
||||
|
||||
In order to continue improving your experience, we have to eventually deprecate certain addons in favor of new, better tools.
|
||||
|
||||
If you're using info/notes, we highly recommend you to migrate to [docs](addons/docs/) instead, and [here is a guide](addons/docs/docs/recipes.md#migrating-from-notesinfo-addons) to help you.
|
||||
If you're using info/notes, we highly recommend you to migrate to [docs](code/addons/docs/) instead, and [here is a guide](code/addons/docs/docs/recipes.md#migrating-from-notesinfo-addons) to help you.
|
||||
|
||||
If you're using contexts, we highly recommend you to migrate to [toolbars](https://github.com/storybookjs/storybook/tree/next/addons/toolbars) and [here is a guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-addon-contexts) to help you.
|
||||
If you're using contexts, we highly recommend you to migrate to [toolbars](https://github.com/storybookjs/storybook/tree/next/code/addons/toolbars) and [here is a guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-addon-contexts) to help you.
|
||||
|
||||
## Badges & Presentation materials
|
||||
|
||||
|
||||
@ -210,4 +210,4 @@ export const Template = (args) => <Button {...args} />
|
||||
</Story>
|
||||
```
|
||||
|
||||
For more info, see a full [Controls example in MDX for Vue](https://raw.githubusercontent.com/storybookjs/storybook/next/examples/vue-kitchen-sink/src/stories/addon-controls.stories.mdx).
|
||||
For more info, see a full [Controls example in MDX for Vue](https://raw.githubusercontent.com/storybookjs/storybook/next/code/examples/vue-kitchen-sink/src/stories/addon-controls.stories.mdx).
|
||||
|
||||
@ -37,7 +37,7 @@ Click on the `Docs` tab to see it:
|
||||
<img src="https://raw.githubusercontent.com/storybookjs/storybook/main/addons/docs/docs/media/docs-tab.png" width="100%" />
|
||||
</center>
|
||||
|
||||
For more information on how it works, see the [`DocsPage` reference](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/docspage.md).
|
||||
For more information on how it works, see the [`DocsPage` reference](https://github.com/storybookjs/storybook/blob/next/code/addons/docs/docs/docspage.md).
|
||||
|
||||
## MDX
|
||||
|
||||
@ -73,7 +73,7 @@ And here's how that's rendered in Storybook:
|
||||
<img src="https://raw.githubusercontent.com/storybookjs/storybook/main/addons/docs/docs/media/mdx-simple.png" width="100%" />
|
||||
</center>
|
||||
|
||||
For more information on `MDX`, see the [`MDX` reference](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/mdx.md).
|
||||
For more information on `MDX`, see the [`MDX` reference](https://github.com/storybookjs/storybook/blob/next/code/addons/docs/docs/mdx.md).
|
||||
|
||||
## Framework support
|
||||
|
||||
@ -83,7 +83,7 @@ Storybook Docs supports all view layers that Storybook supports except for React
|
||||
|
||||
**Note:** `#` = WIP support
|
||||
|
||||
Want to add enhanced features to your favorite framework? Check out this [dev guide](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/multiframework.md)
|
||||
Want to add enhanced features to your favorite framework? Check out this [dev guide](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/multiframework.md)
|
||||
|
||||
## Installation
|
||||
|
||||
@ -108,7 +108,7 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/addons/storyshots/storyshots-core/README.md), you will need to
|
||||
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/code/addons/storyshots/storyshots-core/README.md), you will need to
|
||||
configure Jest to transform MDX stories into something Storyshots can understand:
|
||||
|
||||
Add the following to your Jest configuration:
|
||||
@ -124,12 +124,12 @@ Add the following to your Jest configuration:
|
||||
|
||||
### Be sure to check framework specific installation needs
|
||||
|
||||
- [React](https://github.com/storybookjs/storybook/tree/next/addons/docs/react) (covered here)
|
||||
- [Vue](https://github.com/storybookjs/storybook/tree/next/addons/docs/vue)
|
||||
- [Angular](https://github.com/storybookjs/storybook/tree/next/addons/docs/angular)
|
||||
- [Ember](https://github.com/storybookjs/storybook/tree/next/addons/docs/ember)
|
||||
- [Web Components](https://github.com/storybookjs/storybook/tree/next/addons/docs/web-components)
|
||||
- [Common setup (all other frameworks)](https://github.com/storybookjs/storybook/tree/next/addons/docs/common)
|
||||
- [React](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/react) (covered here)
|
||||
- [Vue](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/vue)
|
||||
- [Angular](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/angular)
|
||||
- [Ember](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/ember)
|
||||
- [Web Components](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/web-components)
|
||||
- [Common setup (all other frameworks)](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/common)
|
||||
|
||||
## Preset options
|
||||
|
||||
@ -229,12 +229,12 @@ addParameters({
|
||||
|
||||
## TypeScript configuration
|
||||
|
||||
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/react/configure/typescript) and should work with SB Docs out of the box. For advanced configuration options, refer to the [Props documentation](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/props-tables.md).
|
||||
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/react/configure/typescript) and should work with SB Docs out of the box. For advanced configuration options, refer to the [Props documentation](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/props-tables.md).
|
||||
|
||||
## More resources
|
||||
|
||||
Want to learn more? Here are some more articles on Storybook Docs:
|
||||
|
||||
- References: [DocsPage](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/docspage.md) / [MDX](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/mdx.md) / [FAQ](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/faq.md) / [Recipes](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/recipes.md) / [Theming](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/theming.md) / [Props](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/props-tables.md)
|
||||
- References: [DocsPage](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/docspage.md) / [MDX](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/mdx.md) / [FAQ](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/faq.md) / [Recipes](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/recipes.md) / [Theming](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/theming.md) / [Props](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/props-tables.md)
|
||||
- Announcements: [Vision](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a) / [DocsPage](https://medium.com/storybookjs/storybook-docspage-e185bc3622bf) / [MDX](https://medium.com/storybookjs/rich-docs-with-storybook-mdx-61bc145ae7bc) / [Framework support](https://medium.com/storybookjs/storybook-docs-for-new-frameworks-b1f6090ee0ea)
|
||||
- Example: [Storybook Design System](https://github.com/storybookjs/design-system)
|
||||
|
||||
@ -55,7 +55,7 @@ import { Badge } from './Badge';
|
||||
storiesOf('Path/to/Badge', module).addParameters({ component: Badge });
|
||||
```
|
||||
|
||||
If you're coming from the `storiesOf` format, there's [a codemod that adds it for you](https://github.com/storybookjs/storybook/blob/next/lib/codemod/README.md#add-component-parameters).
|
||||
If you're coming from the `storiesOf` format, there's [a codemod that adds it for you](https://github.com/storybookjs/storybook/blob/next/code/lib/codemod/README.md#add-component-parameters).
|
||||
|
||||
## Subcomponents parameter
|
||||
|
||||
@ -145,7 +145,7 @@ export default {
|
||||
};
|
||||
```
|
||||
|
||||
You can interleave your own components to customize the auto-generated contents of the page, or pass in different options to the blocks to customize their appearance. For more info see the examples in [official-storybook](https://github.com/storybookjs/storybook/blob/next/examples/official-storybook/stories/addon-docs/addon-docs-blocks.stories.js).
|
||||
You can interleave your own components to customize the auto-generated contents of the page, or pass in different options to the blocks to customize their appearance. For more info see the examples in [official-storybook](https://github.com/storybookjs/storybook/blob/next/code/examples/official-storybook/stories/addon-docs/addon-docs-blocks.stories.js).
|
||||
|
||||
## Story file names
|
||||
|
||||
|
||||
@ -83,7 +83,7 @@ export const WithControls = (args) => <MyComponent {...args} />;
|
||||
<ArgsTable story="Controls" />
|
||||
```
|
||||
|
||||
For a very detailed walkthrough of how to write stories that use controls, see the [addon-controls README](https://github.com/storybookjs/storybook/blob/next/addons/controls/README.md#writing-stories).
|
||||
For a very detailed walkthrough of how to write stories that use controls, read the [documentation](https://storybook.js.org/docs/react/essentials/controls).
|
||||
|
||||
## Customization
|
||||
|
||||
@ -187,20 +187,20 @@ This would render a row with a modified description, a type display with a dropd
|
||||
> - `type: 'number'` is shorthand for `type: { name: 'number' }`
|
||||
> - `control: 'radio'` is shorthand for `control: { type: 'radio' }`
|
||||
|
||||
Controls customization has an entire section in the [`addon-controls` README](https://github.com/storybookjs/storybook/blob/next/addons/controls/README.md#configuration).
|
||||
Controls customization has an entire section in the [documentation](https://storybook.js.org/docs/react/essentials/controls#configuration).
|
||||
|
||||
Here are the possible customizations for the rest of the prop table:
|
||||
|
||||
| Field | Description |
|
||||
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | The name of the property |
|
||||
| `type.required` | Whether or not the property is required |
|
||||
| `description` | A markdown description for the property |
|
||||
| `table.type.summary` | A short version of the type |
|
||||
| `table.type.detail` | A longer version of the type (if it's a complex type) |
|
||||
| `table.defaultValue.summary` | A short version of the default value |
|
||||
| `table.defaultValue.detail` | A longer version of the default value (if it's a complex value) |
|
||||
| `control` | See [`addon-controls` README](https://github.com/storybookjs/storybook/blob/next/addons/controls/README.md#configuration) |
|
||||
| Field | Description |
|
||||
| ---------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `name` | The name of the property |
|
||||
| `type.required` | Whether or not the property is required |
|
||||
| `description` | A markdown description for the property |
|
||||
| `table.type.summary` | A short version of the type |
|
||||
| `table.type.detail` | A longer version of the type (if it's a complex type) |
|
||||
| `table.defaultValue.summary` | A short version of the default value |
|
||||
| `table.defaultValue.detail` | A longer version of the default value (if it's a complex value) |
|
||||
| `control` | See [`addon-controls` README](https://storybook.js.org/docs/react/essentials/controls#configuration) |
|
||||
|
||||
### Custom ArgTypes in MDX
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@ If you want to intersperse longform documentation in your Storybook, for example
|
||||
|
||||
## Mixed CSF / MDX Stories
|
||||
|
||||
Can't decide between CSF and MDX? In transition? Or have you found that each format has its own use? There's nothing stopping you from keeping some of your stories in CSF and some in MDX. And if you want to migrate one way or another, the [csf-to-mdx and mdx-to-csf codemod migrations](https://github.com/storybookjs/storybook/blob/next/lib/codemod/README.md) can help.
|
||||
Can't decide between CSF and MDX? In transition? Or have you found that each format has its own use? There's nothing stopping you from keeping some of your stories in CSF and some in MDX. And if you want to migrate one way or another, the [csf-to-mdx and mdx-to-csf codemod migrations](https://github.com/storybookjs/storybook/blob/next/code/lib/codemod/README.md) can help.
|
||||
|
||||
The only limitation is that your exported titles (CSF: `default.title`, MDX `Meta.title`) should be unique across files. Loading will fail if there are duplicate titles.
|
||||
|
||||
|
||||
@ -14,6 +14,8 @@ Storybook essentials includes the following addons. Addons can be disabled and r
|
||||
- [Docs](https://github.com/storybookjs/storybook/tree/next/code/addons/docs)
|
||||
- [Viewport](https://github.com/storybookjs/storybook/tree/next/code/addons/viewport)
|
||||
- [Toolbars](https://github.com/storybookjs/storybook/tree/next/code/addons/toolbars)
|
||||
- [Measure](https://github.com/storybookjs/storybook/tree/next/code/addons/measure)
|
||||
- [Outline](https://github.com/storybookjs/storybook/tree/next/code/addons/outline)
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@ -67,7 +67,7 @@ And `square`:
|
||||
|
||||
## More info
|
||||
|
||||
For more info, check out the [Storybook Docs README](https://github.com/storybookjs/storybook/tree/next/addons/docs).
|
||||
For more info, check out the [Storybook Docs README](https://github.com/storybookjs/storybook/tree/next/code/addons/docs).
|
||||
|
||||
We want your feedback to help make this more useful.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-angular-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-ember-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-app
|
||||
npx sb init -t html
|
||||
npx storybook init -t html
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-preact-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-react-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-app
|
||||
npx sb init -t server
|
||||
npx storybook init -t server
|
||||
```
|
||||
|
||||
To configure the server that Storybook will connect to, export a global parameter `parameters.server.url` in `.storybook/preview.js`:
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-svelte-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-vue-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-vue3-app
|
||||
npx sb init
|
||||
npx storybook init
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
|
||||
|
||||
```sh
|
||||
cd my-app
|
||||
npx sb init -t web_components
|
||||
npx storybook init -t web_components
|
||||
```
|
||||
|
||||
For more information visit: [storybook.js.org](https://storybook.js.org)
|
||||
|
||||
@ -188,7 +188,7 @@ export const WithAdditionalActions = () => (
|
||||
title: 'Open on GitHub',
|
||||
onClick: () => {
|
||||
globalWindow.location.href =
|
||||
'https://github.com/storybookjs/storybook/blob/next/lib/components/src/blocks/Preview.stories.tsx#L140-L147';
|
||||
'https://github.com/storybookjs/storybook/blob/next/code/lib/blocks/src/components/Preview.stories.tsx#L165-L186';
|
||||
},
|
||||
},
|
||||
]}
|
||||
|
||||
@ -53,4 +53,4 @@ If the CLI cannot detect your project type, it will ask you. You can also force
|
||||
npx sb init --type <type>
|
||||
```
|
||||
|
||||
Where type is one of the project types defined in [project_types.js](https://github.com/storybookjs/storybook/blob/next/lib/cli/src/project_types.ts)
|
||||
Where type is one of the project types defined in [project_types.ts](https://github.com/storybookjs/storybook/blob/next/code/lib/cli/src/project_types.ts)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<h1>Source Loader</h1>
|
||||
|
||||
Storybook `source-loader` is a webpack loader that annotates Storybook story files with their source code. It powers the [storysource](https://github.com/storybookjs/storybook/tree/next/addons/storysource) and [docs](https://github.com/storybookjs/storybook/tree/next/addons/docs) addons.
|
||||
Storybook `source-loader` is a webpack loader that annotates Storybook story files with their source code. It powers the [storysource](https://github.com/storybookjs/storybook/tree/next/code/addons/storysource) and [docs](https://github.com/storybookjs/storybook/tree/next/code/addons/docs) addons.
|
||||
|
||||
- [Options](#options)
|
||||
- [parser](#parser)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user