# @kadira/storybook-deployer

> Deploy your storybook as a webapp.

Latest version **1.2.0** (published 2016-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kadira/storybook-deployer
pnpm add @kadira/storybook-deployer
yarn add @kadira/storybook-deployer
bun add @kadira/storybook-deployer
```

Provides the command `storybook-to-ghpages`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2016-09-09 |
| First published | 2016-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 892 |
| Author | Arunoda Susiripala |
| Maintainers | arunoda, kadira_user, mnmtanish, pahans, roonyh, thinkholic |
| Keywords | storybook, deploy, static |

## Links

- npm: https://www.npmjs.com/package/@kadira/storybook-deployer
- Repository: https://github.com/kadirahq/storybook-deployer
- Homepage: https://github.com/kadirahq/storybook-deployer#readme
- Issues: https://github.com/kadirahq/storybook-deployer/issues
- npm.io page: https://npm.io/package/@kadira/storybook-deployer

## Dependencies (2)

- [shelljs](https://npm.io/package/shelljs.md) ^0.7.0
- [git-url-parse](https://npm.io/package/git-url-parse.md) ^6.0.2

## Recent versions

- 1.2.0 (latest) — 2016-09-09
- 1.1.0 — 2016-08-09
- 1.0.0 — 2016-05-06

## 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:

```js
{
  "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:

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

> Make sure to set the output directory as **`.out`**.

---
_Source: https://npm.io/package/@kadira/storybook-deployer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._