diff --git a/.teamcity/OpenSourceProjects_Storybook/buildTypes/OpenSourceProjects_Storybook_Docs.kt b/.teamcity/OpenSourceProjects_Storybook/buildTypes/OpenSourceProjects_Storybook_Docs.kt index eb8f8fd6c767..3d35c15ab16e 100644 --- a/.teamcity/OpenSourceProjects_Storybook/buildTypes/OpenSourceProjects_Storybook_Docs.kt +++ b/.teamcity/OpenSourceProjects_Storybook/buildTypes/OpenSourceProjects_Storybook_Docs.kt @@ -12,7 +12,7 @@ object OpenSourceProjects_Storybook_Docs : BuildType({ artifactRules = "docs/public => docs.zip" params { - param("Deploy branch", "release/3.4") + param("Deploy branch", "release/4.0") } vcs { diff --git a/README.md b/README.md index a44c0e573873..5da3292fd660 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ It allows you to browse a component library, view the different states of each c README for: - [![Alpha](https://img.shields.io/npm/v/@storybook/core/alpha.svg)](https://github.com/storybooks/storybook) -- [![Latest](https://img.shields.io/npm/v/@storybook/core/latest.svg)](https://github.com/storybooks/storybook/tree/release/3.4) +- [![Latest](https://img.shields.io/npm/v/@storybook/core/latest.svg)](https://github.com/storybooks/storybook/tree/release/4.0) 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. diff --git a/addons/notes/README.md b/addons/notes/README.md index 731bb0924a2e..6d19c6a1e11d 100644 --- a/addons/notes/README.md +++ b/addons/notes/README.md @@ -40,7 +40,7 @@ import { storiesOf } from '@storybook/react'; import Component from './Component'; storiesOf('Component', module).add('with some emoji', () => , { - notes: 'A very simple component' + notes: 'A very simple component', }); ``` @@ -54,6 +54,6 @@ import Component from './Component'; import someMarkdownText from './someMarkdownText.md'; storiesOf('Component', module).add('With Markdown', () => , { - notes: { markdown: someMarkdownText } + notes: { markdown: someMarkdownText }, }); ``` diff --git a/addons/ondevice-notes/README.md b/addons/ondevice-notes/README.md index 95f8ae9898cf..09e549869bb2 100644 --- a/addons/ondevice-notes/README.md +++ b/addons/ondevice-notes/README.md @@ -8,7 +8,7 @@ Storybook Addon On Device Notes allows you to write notes (text or markdown) for ### Getting Started -**NOTE: Documentation on master branch is for alpha version, stable release is on [release/4.0](https://github.com/storybooks/storybook/tree/release/3.4/addons/)** +**NOTE: Documentation on master branch is for alpha version, stable release is on [release/4.0](https://github.com/storybooks/storybook/tree/release/4.0/addons/)** ```sh yarn add -D @storybook/addon-ondevice-notes @@ -46,6 +46,6 @@ import { storiesOf } from '@storybook/react-native'; import Component from './Component'; storiesOf('Component', module).add('with some emoji', () => , { - notes: 'A very simple component' + notes: 'A very simple component', }); ``` diff --git a/docs/src/pages/addons/addon-gallery/index.md b/docs/src/pages/addons/addon-gallery/index.md index 9780a7dc979f..9aa0f0a4b066 100644 --- a/docs/src/pages/addons/addon-gallery/index.md +++ b/docs/src/pages/addons/addon-gallery/index.md @@ -11,34 +11,34 @@ This is a list of available addons for Storybook. With a11y you can test compliance of your stories with web accessibility standards. -### [Actions](https://github.com/storybooks/storybook/tree/release/3.4/addons/actions) +### [Actions](https://github.com/storybooks/storybook/tree/release/4.0/addons/actions) With actions, you can inspect events related to your components. This is pretty neat when you are manually testing your components. Also, you can think of this as a way to document events in your components. -### [Links](https://github.com/storybooks/storybook/tree/release/3.4/addons/links) +### [Links](https://github.com/storybooks/storybook/tree/release/4.0/addons/links) With links you can link stories together. With that, you can build demos and prototypes directly from your UI components. -### [Knobs](https://github.com/storybooks/storybook/tree/release/3.4/addons/knobs) +### [Knobs](https://github.com/storybooks/storybook/tree/release/4.0/addons/knobs) Knobs allow you to edit React props dynamically using the Storybook UI. You can also use Knobs as dynamic variables inside your stories. -### [Notes](https://github.com/storybooks/storybook/tree/release/3.4/addons/notes) +### [Notes](https://github.com/storybooks/storybook/tree/release/4.0/addons/notes) With this addon, you can write notes for each story in your component. This is pretty useful when you are working with a team. -### [Info](https://github.com/storybooks/storybook/tree/release/3.4/addons/info) +### [Info](https://github.com/storybooks/storybook/tree/release/4.0/addons/info) If you are using Storybook as a style guide, then this addon will help you to build a nice-looking style guide with docs, automatic sample source code with a PropType explorer. -### [Options](https://github.com/storybooks/storybook/tree/release/3.4/addons/options) +### [Options](https://github.com/storybooks/storybook/tree/release/4.0/addons/options) The Storybook webapp UI can be customised with this addon. It can be used to change the header, show/hide various UI elements and to enable full-screen mode by default. -### [Storyshots](https://github.com/storybooks/storybook/tree/release/3.4/addons/storyshots) +### [Storyshots](https://github.com/storybooks/storybook/tree/release/4.0/addons/storyshots) Storyshots is a way to automatically jest-snapshot all your stories. [More info here](/testing/structural-testing/). @@ -46,13 +46,13 @@ Storyshots is a way to automatically jest-snapshot all your stories. [More info Redirects console output (logs, errors, warnings) into Action Logger Panel. `withConsole` decorator notifies from what stories logs are coming. -### [Backgrounds](https://github.com/storybooks/storybook/tree/release/3.4/addons/background) +### [Backgrounds](https://github.com/storybooks/storybook/tree/release/4.0/addons/background) With this addon, you can switch between background colors and background images for your preview components. It is really helpful for styleguides. -### [Viewport](https://github.com/storybooks/storybook/tree/release/3.4/addons/viewport) +### [Viewport](https://github.com/storybooks/storybook/tree/release/4.0/addons/viewport) -Viewport allows your stories to be displayed in different sizes and layouts in [Storybook](https://storybook.js.org). This helps build responsive components inside of Storybook. +Viewport allows your stories to be displayed in different sizes and layouts in [Storybook](https://storybook.js.org). This helps build responsive components inside of Storybook. ### [Google Analytics](https://github.com/storybooks/storybook/tree/master/addons/google-analytics) @@ -146,13 +146,17 @@ reset state. Convert stories into Sketch 💎 symbols. ### [styled components theme](https://github.com/echoulen/storybook-addon-styled-component-theme) + styled components theme selection. ### [AngularJS](https://github.com/titonobre/storybook-addon-angularjs) + Create stories with AngularJS(1.x) components. ### [JSS theme](https://github.com/vertexbz/storybook-addon-jss-theme) + JSS theme selection. ### [React live edit](https://github.com/vertexbz/storybook-addon-react-live-edit) + Provides live react story editing and preview.