GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 23:01:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Composition/Storyshots: Env var docs.

Browse Source
This commit is contained in:
Brian Blakely 2021-08-18 22:42:34 -04:00
parent 266c78662c
commit e2ecd8677e
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
addons/storyshots/storyshots-puppeteer/README.md
View File

@ -123,6 +123,8 @@ initStoryshots({
});
```
Alternatively, you may set the `SB_CHROMIUM_PATH` environment variable. If both are set, then `chromeExecutablePath` will take precedence.
### Specifying a custom Puppeteer `browser` instance
You might use the async `getCustomBrowser` function to obtain a custom instance of a Puppeteer `browser` object. This will prevent `storyshots-puppeteer` from creating its own `browser`. It will create and close pages within the `browser`, and it is your responsibility to manage the lifecycle of the `browser` itself.

8
docs/workflows/storybook-composition.md
View File

@ -23,7 +23,7 @@ In your [`storybook/main.js`](../configure/overview.md#configure-story-rendering
<!-- prettier-ignore-end -->
<div class="aside">
We would like to point out that there's some limitations to composition. For now addons in composed Storybooks will not work as they do in non composed Storybooks.
We would like to point out that there's some limitations to composition. For now addons in composed Storybooks will not work as they do in non composed Storybooks.
</div>
## Compose local Storybooks
@ -70,6 +70,12 @@ So far we've covered how we can use composition with local or published Storyboo
npx sb extract
```
<div class="aside">
`sb extract` uses [Puppeteer](https://www.npmjs.com/package/puppeteer), which downloads and installs Chromium. Specify your own locally-installed Chromium executable by setting the environment variable `SB_CHROMIUM_PATH`.
</div>
Using this command will generate a `stories.json` file in the default build directory (`storybook-static`) with information regarding your Storybook. Here's how it might look:
<!-- prettier-ignore-start -->