@kadira/storybook-deployer

Deploy your storybook as a webapp.

Stats

StarsIssuesVersionUpdatedCreatedSize
@kadira/storybook-deployer
748231.2.05 years ago5 years agoMinified + gzip package size for @kadira/storybook-deployer in KB

Readme

Storybook Deployer

This is a simple tool allows you to deploy your Storybook into a static hosting service. (Currently, GitHub Pages only.)

Getting Started

Install Storybook Deployer with:

npm i --save @kadira/storybook-deployer

Then add a NPM script like this:

{
  "scripts": {
    ...
    "deploy-storybook": "storybook-to-ghpages",
    ...
  }
}

Then you can run npm run deploy-storybook to deploy the Storybook to GitHub Pages.

Custom Build Configuration

If you customize the build configuration with some additional params (like static file directory), then you need to expose another NPM script like this:

{
  "scripts": {
    ...
    "build-storybook": "build-storybook -s public -o .out",
    ...
  }
}

Make sure to set the output directory as .out.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.