Skip to content

Commit

Permalink
IMPROVE docs for standalone
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelangen committed Mar 4, 2019
1 parent 0dbf67c commit 793c8ff
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions docs/src/pages/configurations/standalone-options/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ storybook({

Mode is defining what Storybook mode will be applied:

dev - run Storybook in a dev mode - similar to "start-storybook" in CLI
### dev

run Storybook in a dev mode - similar to `start-storybook` in CLI

```js
const storybook = require('@storybook/react/standalone');
Expand All @@ -38,7 +40,9 @@ storybook({
});
```

static - build static version of Storybook - similar to "build-storybook" in CLI
### static

build static version of Storybook - similar to `build-storybook` in CLI

```js
const storybook = require('@storybook/react/standalone');
Expand All @@ -53,28 +57,28 @@ Other options are similar to those in the CLI.

## For "dev" mode:

Options:

port [number] Port to run Storybook
host [string] Host to run Storybook
staticDir <dir-names> Directory where to load static files from, array of strings
configDir [dir-name] Directory where to load Storybook configurations from
https Serve Storybook over HTTPS. Note: You must provide your own certificate information.
sslCa <ca> Provide an SSL certificate authority. (Optional with "https", required if using a self-signed certificate)
sslCert <cert> Provide an SSL certificate. (Required with "https")
sslKey <key> Provide an SSL key. (Required with "https")
smokeTest Exit after successful start
ci CI mode (skip interactive prompts, don't open browser)
quiet Suppress verbose build output
```plaintext
port [number] Port to run Storybook
host [string] Host to run Storybook
staticDir <dir-names> Directory where to load static files from, array of strings
configDir [dir-name] Directory where to load Storybook configurations from
https Serve Storybook over HTTPS. Note: You must provide your own certificate information.
sslCa <ca> Provide an SSL certificate authority. (Optional with "https", required if using a self-signed certificate)
sslCert <cert> Provide an SSL certificate. (Required with "https")
sslKey <key> Provide an SSL key. (Required with "https")
smokeTest Exit after successful start
ci CI mode (skip interactive prompts, don't open browser)
quiet Suppress verbose build output
```

## For "static" mode:

Options:

staticDir <dir-names> Directory where to load static files from, array of strings
outputDir [dir-name] Directory where to store built files
configDir [dir-name] Directory where to load Storybook configurations from
watch Enable watch mode
```plaintext
staticDir <dir-names> Directory where to load static files from, array of strings
outputDir [dir-name] Directory where to store built files
configDir [dir-name] Directory where to load Storybook configurations from
watch Enable watch mode
```

Example:

Expand Down

1 comment on commit 793c8ff

@vercel
Copy link

@vercel vercel bot commented on 793c8ff Mar 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deployment failed with the following error:

Builds rate limit exceeded (0 of 100 remaining). Try again in 21h

Please sign in to comment.