diff --git a/.spelling b/.spelling index 1285c9f1edb1..62d5cce6915a 100644 --- a/.spelling +++ b/.spelling @@ -15,3 +15,77 @@ styleguide-type styleguides angularjs api +github +config +cra +PRs +cleanup +2 +ES2016 +prerelease +rc +npm +apollo +codemod +storyshots +graphql +lerna +eslint +js +CommonJS +IO +reflow +Node.js. +dialog +10 +unisolated +3 +13 +Browserify +bundlers +2013 +centered +center +GraphiQL +graphiql +url +javascript +storyshots' +storybook.js.org +CRNA +postmessage +websocket +EventEmitter +codemods +jscodeshift +npm3 +HMR +Redux +storybook-ui +react-komposer +redux +serializable +params + - addons/actions/node_modules/@storybook/addons/README.md +storybooks.js.org + - addons/actions/node_modules/asap/README.md +YuzuJS +setImmediate +Malte +Ubl +Katić +Domenic +Kowal +Zakas + - addons/actions/node_modules/balanced-match/README.md +Gruber +julian +juliangruber.com + - addons/actions/node_modules/brace-expansion/README.md +Schlueter + - addons/links/README.md +linkTo + - lib/ui/README.md +setOptions +setStories +onStory diff --git a/CHANGELOG.md b/CHANGELOG.md index e6cbf187d9c0..f62d39b44fc1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -94,7 +94,7 @@ This is a major release with breaking changes. See our [migration guide](https:/ - First pass at update the contribution instructions () - Remove text transform uppercase for knob labels () - Update links in PRs section of CONTRIBUTING.md () -- Updated dead getstorybook.io links to storybooks.js.org () +- Updated dead getstorybook.io links to storybook.js.org () - Do not ignore story.js in prepublish () - addon-info: make the info overlay be fixed () - Update lerna to the latest version 🚀 () diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb2139c3aa04..bd82a35fd13c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,9 +117,9 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p - Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing). -- `bug`s should be labeled `merged` when merged, and be closed when the issue is fixed and released. +- `bug`s should be labelled `merged` when merged, and be closed when the issue is fixed and released. -- `feature`s, `maintenance`s, `greenkeeper`s should be labeled `merged` when merged, and closed when released or if the feature is deemed not appropriate. +- `feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged, and closed when released or if the feature is deemed not appropriate. - `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks. diff --git a/HISTORY.md b/HISTORY.md index 3635c5d18c49..423b8ca19d34 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,6 +1,6 @@ ## v.Next -- Deprecated `{ linkTo, action }` as built-in addons: . From 3.0 use them as you would [any other addon](https://storybooks.js.org/docs/react-storybook/addons/using-addons/). +- Deprecated `{ linkTo, action }` as built-in addons: . From 3.0 use them as you would [any other addon](https://storybook.js.org/docs/react-storybook/addons/using-addons/). Before: diff --git a/MIGRATION.md b/MIGRATION.md index 3ce7c5405d7c..aea952a824a7 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -24,7 +24,7 @@ You can find the guide to upgrading your webpack config [on webpack.js.org](http All our packages have been renamed and published to npm as version 3.0.0. > We have adopted the same versioning strategy as have been adopted by babel, jest and apollo. -> It's a strategy best suited for ecosystem type tools, which consist of many seperately installable features / packages. +> It's a strategy best suited for ecosystem type tools, which consist of many separately installable features / packages. > We think this describes storybook pretty well. The new package names are: @@ -59,13 +59,13 @@ The new package names are: If your codebase is small, it's probably doable to just replace them by hand. (in your codebase and in `package.json`). -But if you have a lot of occurances in your codebase, you can use a [codemod we created](./lib/codemod) for you. +But if you have a lot of occurrences in your codebase, you can use a [codemod we created](./lib/codemod) for you. > A codemod makes automatic changed to your app's code. You have to change your `package.json`, prune old and install new dependencies by hand. -`npm prune` will remove all dependecies from `node_modules` which are no longer referenced in `package.json`. +`npm prune` will remove all dependencies from `node_modules` which are no longer referenced in `package.json`. ### Deprecated embedded addons diff --git a/README.md b/README.md index 08abd3400aff..edb110579f09 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It allows you to browse a component library, view the different states of each c Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies. -Storybook comes with a lot of [addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile. +Storybook comes with a lot of [addons](https://storybook.js.org/docs/react-storybook/addons/introduction) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile. ## Table of contents @@ -45,7 +45,7 @@ getstorybook Once it's installed, you can `npm run storybook` and it will run the development server on your local machine, and give you a URL to browse some sample stories. -For full documentation on using Storybook visit: [storybooks.js.org](https://storybooks.js.org) +For full documentation on using Storybook visit: [storybook.js.org](https://storybook.js.org) ## Projects @@ -95,14 +95,14 @@ We welcome contributions to Storybook! - `npm run lint:js` - will check js - `npm run lint:markdown` - will check markdown + code samples -- `npm run lint:js -- --fix` - will autofix js -- `npm run lint:markdown -- -o` - will autofix markdown +- `npm run lint:js -- --fix` - will automatically fix js +- `npm run lint:markdown -- -o` - will automatically fix markdown #### `npm run test` -> boolean check if unittests all pass - uses jest +> boolean check if unit tests all pass - uses jest -- `npm run test:watch` - will run tests in watchmode +- `npm run test:watch` - will run tests in watch-mode ### Backers diff --git a/addons/actions/README.md b/addons/actions/README.md index b85d0d1f933a..5b9de60206ee 100644 --- a/addons/actions/README.md +++ b/addons/actions/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook Addon Actions can be used to display data received by event handlers in [Storybook](https://storybooks.js.org). +Storybook Addon Actions can be used to display data received by event handlers in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react) and diff --git a/addons/centered/README.md b/addons/centered/README.md index 8a926c00ea56..3e2678fcf2e8 100644 --- a/addons/centered/README.md +++ b/addons/centered/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybooks.js.org). +Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react). diff --git a/addons/comments/README.md b/addons/comments/README.md index 115e8d406940..0ceabaf6ecb1 100644 --- a/addons/comments/README.md +++ b/addons/comments/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook Comments Addon allows you to add comments for your stories in [Storybook](https://storybooks.js.org). +Storybook Comments Addon allows you to add comments for your stories in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react). diff --git a/addons/graphql/README.md b/addons/graphql/README.md index a4047b9fe190..b227c0ff465a 100644 --- a/addons/graphql/README.md +++ b/addons/graphql/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook GraphiQL Addon can be used to display the GraphiQL IDE with example queries in [Storybook](https://storybooks.js.org). +Storybook GraphiQL Addon can be used to display the GraphiQL IDE with example queries in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react). diff --git a/addons/info/README.md b/addons/info/README.md index 592d5b668ff7..1c5a7208ffdd 100644 --- a/addons/info/README.md +++ b/addons/info/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook Info Addon will show additional information for your stories in [Storybook](https://storybooks.js.org). +Storybook Info Addon will show additional information for your stories in [Storybook](https://storybook.js.org). Useful when you want to display usage or other types of documentation alongside your story. This addon works with Storybook for: diff --git a/addons/knobs/README.md b/addons/knobs/README.md index 68884de2b0dc..666c1422eb2c 100644 --- a/addons/knobs/README.md +++ b/addons/knobs/README.md @@ -8,7 +8,7 @@ [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) Storybook Addon Knobs allow you to edit React props dynamically using the Storybook UI. -You can also use Knobs as a dynamic variable inside stories in [Storybook](https://storybooks.js.org). +You can also use Knobs as a dynamic variable inside stories in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react). @@ -137,9 +137,9 @@ const options = { const value = number(label, defaultValue, options); ``` -### color +### colour -Allows you to get a color from the user. +Allows you to get a colour from the user. ```js const label = 'Color'; diff --git a/addons/links/README.md b/addons/links/README.md index 39c57d38fac6..652214f7a3f3 100644 --- a/addons/links/README.md +++ b/addons/links/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -The Storybook Links addon can be used to create links between stories in [Storybook](https://storybooks.js.org). +The Storybook Links addon can be used to create links between stories in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react) and diff --git a/addons/notes/README.md b/addons/notes/README.md index 8b8e3c7b0a0d..94826bc20f08 100644 --- a/addons/notes/README.md +++ b/addons/notes/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook Addon Notes allows you to write notes for your stories in [Storybook](https://storybooks.js.org). +Storybook Addon Notes allows you to write notes for your stories in [Storybook](https://storybook.js.org). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react). diff --git a/addons/options/README.md b/addons/options/README.md index 2db3b41a324f..c85a55af5c58 100644 --- a/addons/options/README.md +++ b/addons/options/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -The Options addon can be used to set configure the [Storybook](https://storybooks.js.org) UI. +The Options addon can be used to set configure the [Storybook](https://storybook.js.org) UI. This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react) and diff --git a/addons/storyshots/README.md b/addons/storyshots/README.md index 1d164569dcd5..434c25e3792e 100644 --- a/addons/storyshots/README.md +++ b/addons/storyshots/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybooks.js.org/). +StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybook.js.org/). This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react) and @@ -100,7 +100,7 @@ initStoryshots({ ### `framework` -If you are running tests from outside of your app's directory, storyshot's detection of which framework you are using may fail. Pass `"react"` or `"react-native"` to short-circuit this. +If you are running tests from outside of your app's directory, storyshots' detection of which framework you are using may fail. Pass `"react"` or `"react-native"` to short-circuit this. ### `test` diff --git a/app/react-native/readme.md b/app/react-native/readme.md index 7d03536db9c7..adc325f36ebf 100644 --- a/app/react-native/readme.md +++ b/app/react-native/readme.md @@ -11,7 +11,7 @@ With Storybook for React Native you can design and develop individual React Nati ![Storybook Screenshot](docs/assets/readme/screenshot.png) -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) ## Getting Started diff --git a/app/react-native/src/server/addons.js b/app/react-native/src/server/addons.js index 431b07f246bb..05ee4df423da 100644 --- a/app/react-native/src/server/addons.js +++ b/app/react-native/src/server/addons.js @@ -4,5 +4,5 @@ import '@storybook/addon-links/register'; deprecate( () => {}, - '@storybook/react-native/addons is deprecated. See https://storybooks.js.org/docs/react-storybook/addons/using-addons/' + '@storybook/react-native/addons is deprecated. See https://storybook.js.org/docs/react-storybook/addons/using-addons/' )(); diff --git a/app/react/README.md b/app/react/README.md index e7de9fb29279..31131395211d 100644 --- a/app/react/README.md +++ b/app/react/README.md @@ -23,12 +23,12 @@ cd my-react-app getstorybook ``` -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) * * * -Storybook also comes with a lot of [addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) and a great API to customize as you wish. -You can also build a [static version](https://storybooks.js.org/docs/react-storybook/basics/exporting-storybook) of your storybook and deploy it anywhere you want. +Storybook also comes with a lot of [addons](https://storybook.js.org/docs/react-storybook/addons/introduction) and a great API to customize as you wish. +You can also build a [static version](https://storybook.js.org/docs/react-storybook/basics/exporting-storybook) of your storybook and deploy it anywhere you want. Here are some featured storybooks that you can reference to see how Storybook works: @@ -37,6 +37,6 @@ Here are some featured storybooks that you can reference to see how Storybook wo ## Docs -- [Basics](https://storybooks.js.org/docs/react-storybook/basics/introduction) -- [Configurations](https://storybooks.js.org/docs/react-storybook/configurations/default-config) -- [Addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) +- [Basics](https://storybook.js.org/docs/react-storybook/basics/introduction) +- [Configurations](https://storybook.js.org/docs/react-storybook/configurations/default-config) +- [Addons](https://storybook.js.org/docs/react-storybook/addons/introduction) diff --git a/app/react/addons.js b/app/react/addons.js index 4c6c02a4be1b..3a4c7938924c 100644 --- a/app/react/addons.js +++ b/app/react/addons.js @@ -4,5 +4,5 @@ import '@storybook/addon-links/register'; deprecate( () => {}, - '@storybook/react/addons is deprecated. See https://storybooks.js.org/docs/react-storybook/addons/using-addons/' + '@storybook/react/addons is deprecated. See https://storybook.js.org/docs/react-storybook/addons/using-addons/' )(); diff --git a/app/react/demo/src/stories/Welcome.js b/app/react/demo/src/stories/Welcome.js index 50979fcd203d..bb59a63aa0dc 100644 --- a/app/react/demo/src/stories/Welcome.js +++ b/app/react/demo/src/stories/Welcome.js @@ -97,7 +97,7 @@ export default class Welcome extends React.Component { {' '} Writing Stories diff --git a/examples/cra-storybook/src/stories/Welcome.js b/examples/cra-storybook/src/stories/Welcome.js index 50979fcd203d..bb59a63aa0dc 100644 --- a/examples/cra-storybook/src/stories/Welcome.js +++ b/examples/cra-storybook/src/stories/Welcome.js @@ -97,7 +97,7 @@ export default class Welcome extends React.Component { {' '} Writing Stories diff --git a/examples/test-cra/src/__snapshots__/storyshots.test.js.snap b/examples/test-cra/src/__snapshots__/storyshots.test.js.snap index 572220639b8c..b8f63426bda8 100644 --- a/examples/test-cra/src/__snapshots__/storyshots.test.js.snap +++ b/examples/test-cra/src/__snapshots__/storyshots.test.js.snap @@ -170,7 +170,7 @@ exports[`Storyshots Welcome to Storybook 1`] = ` Have a look at the Writing Stories diff --git a/lib/addons/README.md b/lib/addons/README.md index 678555d97174..774b8a33c47d 100644 --- a/lib/addons/README.md +++ b/lib/addons/README.md @@ -13,4 +13,4 @@ It stores addon loaders, communication channel and other resources which can be * * * -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) diff --git a/lib/channel-postmessage/README.md b/lib/channel-postmessage/README.md index 8e69f9732496..3b20b066b932 100644 --- a/lib/channel-postmessage/README.md +++ b/lib/channel-postmessage/README.md @@ -17,4 +17,4 @@ const channel = createChannel({ key: 'postmsg-key' }) * * * -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) diff --git a/lib/channel-websocket/README.md b/lib/channel-websocket/README.md index b03cc12cf5ec..8243638e6870 100644 --- a/lib/channel-websocket/README.md +++ b/lib/channel-websocket/README.md @@ -17,4 +17,4 @@ const channel = createChannel({ url: 'ws://localhost:9001' }) * * * -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybooks.js.org) diff --git a/lib/channels/README.md b/lib/channels/README.md index cfb2ebdd2db5..2cd8f93e7436 100644 --- a/lib/channels/README.md +++ b/lib/channels/README.md @@ -45,4 +45,4 @@ const channel = addons.getChannel(); * * * -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) diff --git a/lib/cli/README.md b/lib/cli/README.md index 2971ce625db3..afc0936fb227 100644 --- a/lib/cli/README.md +++ b/lib/cli/README.md @@ -13,7 +13,7 @@ In the future it will also add other useful generators and migration tooling. ![Screenshot](docs/getstorybook.png) -First install the storybook cli globally. +First install the storybook CLI globally. ```sh npm i -g @storybook/cli @@ -40,4 +40,4 @@ If you don't want to use `yarn` always you can use the `--use-npm` option like t getstorybook --use-npm ``` -For more information visit: [storybooks.js.org](https://storybooks.js.org) +For more information visit: [storybook.js.org](https://storybook.js.org) diff --git a/lib/cli/bin/generate.js b/lib/cli/bin/generate.js index 8dce91cf2298..4f2ef441ac2f 100755 --- a/lib/cli/bin/generate.js +++ b/lib/cli/bin/generate.js @@ -55,7 +55,7 @@ const end = () => { logger.log('\nTo run your storybook, type:\n'); codeLog([runStorybookCommand]); - logger.log('\nFor more information visit:', chalk.cyan('https://storybooks.js.org')); + logger.log('\nFor more information visit:', chalk.cyan('https://storybook.js.org')); // Add a new line for the clear visibility. logger.log(); @@ -128,7 +128,7 @@ switch (projectType) { default: paddedLog(`Unsupported Project type. (code: ${projectType})`); - paddedLog('Visit https://storybooks.js.org for more information.'); + paddedLog('Visit https://storybook.js.org for more information.'); // Add a new line for the clear visibility. logger.log(); diff --git a/lib/cli/generators/REACT_SCRIPTS/template/src/stories/Welcome.js b/lib/cli/generators/REACT_SCRIPTS/template/src/stories/Welcome.js index 9d106d3dd952..a8399951d12e 100644 --- a/lib/cli/generators/REACT_SCRIPTS/template/src/stories/Welcome.js +++ b/lib/cli/generators/REACT_SCRIPTS/template/src/stories/Welcome.js @@ -97,7 +97,7 @@ export default class Welcome extends React.Component { {' '} Writing Stories diff --git a/lib/cli/generators/WEBPACK_REACT/template/.storybook/webpack.config.js b/lib/cli/generators/WEBPACK_REACT/template/.storybook/webpack.config.js index a26d89ae8c17..985f61741c4b 100644 --- a/lib/cli/generators/WEBPACK_REACT/template/.storybook/webpack.config.js +++ b/lib/cli/generators/WEBPACK_REACT/template/.storybook/webpack.config.js @@ -1,6 +1,6 @@ // you can use this file to add your custom webpack plugins, loaders and anything you like. // This is just the basic way to add additional webpack configurations. -// For more information refer the docs: https://storybooks.js.org/docs/react-storybook/configurations/custom-webpack-config +// For more information refer the docs: https://storybook.js.org/docs/react-storybook/configurations/custom-webpack-config // IMPORTANT // When you add this file, we won't add the default configurations which is similar diff --git a/lib/ui/README.md b/lib/ui/README.md index 35b5ae70053d..d05b49cae40b 100644 --- a/lib/ui/README.md +++ b/lib/ui/README.md @@ -7,7 +7,7 @@ [![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/) -Storybook UI the core UI of [storybook](https://storybooks.js.org). +Storybook UI the core UI of [storybook](https://storybook.js.org). It's a React based UI which you can initialize with a simple function. You can configure it by providing a provider API.