Skip to content

Commit

Permalink
yml instead of js, fix extra space in heading, run pretty-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mickmcgrath13 committed Nov 2, 2023
1 parent de8530f commit abb7942
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/sharing/publish-storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ When you publish Storybook, you also get component history and versioning down t

![Library history in Chromatic](./workflow-history-versioning.png)

## Publish Storybook to other services
## Publish Storybook to other services

Since Storybook is built as a static web application, you can also publish it to any web host, including [GitHub Pages](https://docs.github.com/en/pages), [Netlify](https://www.netlify.com/), [AWS S3](https://aws.amazon.com/s3/), and more. However, features such as [Composition](./storybook-composition.md), [embedding stories](./embed.md), history, versioning, and assets may require tighter integration with Storybook APIs and secure authentication. If you want to know more about headers, you can refer to the [Migration guide](https://github.com/storybookjs/storybook/blob/main/MIGRATION.md#deploying-build-artifacts). Additionally, if you want to learn about the Component Publishing Protocol (CPP), you can find more information below.

Expand All @@ -142,7 +142,7 @@ To deploy Storybook on GitHub Pages, use the community-built [Deploy Storybook t

<CodeSnippets
paths={[
'common/ghp-github-action.js.mdx',
'common/ghp-github-action.yml.mdx',
]}
/>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
```shell
```yml
# .github/workflows/deploy-github-pages.yaml

# Workflow name
Expand All @@ -8,7 +8,7 @@ on:
# Event for the workflow to run on
push:
branches:
- "your-branch-name" # Replace with the branch you want to deploy from
- 'your-branch-name' # Replace with the branch you want to deploy from

permissions:
contents: read
Expand All @@ -21,20 +21,19 @@ jobs:
runs-on: ubuntu-latest
# Job steps
steps:
# Manual Checkout
# Manual Checkout
- uses: actions/checkout@v3


# Set up Node
- uses: actions/setup-node@v3
with:
node-version: "16.x"
node-version: '16.x'

#👇 Add Storybook build and deploy to GitHub Pages as a step in the workflow
- uses: bitovi/github-actions-storybook-to-github-pages@v1.0.1
with:
install_command: yarn install # default: npm ci
build_command: yarn build-storybook # default: npm run build-storybook
path: storybook-static # default: dist/storybook
checkout: false # default: true
install_command: yarn install # default: npm ci
build_command: yarn build-storybook # default: npm run build-storybook
path: storybook-static # default: dist/storybook
checkout: false # default: true
```

0 comments on commit abb7942

Please sign in to comment.