d2caaeab64
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either. Here's an example: ![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png) ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [x] Examples updated - [ ] Telemetry added. In case of a feature if it's used or not. ## Documentation / Examples - [x] Make sure the linting passes
51 lines
2 KiB
Markdown
51 lines
2 KiB
Markdown
# Example app with Storybook setup for SCSS in Styled-jsx
|
|
|
|
This example shows Styled-jsx (with SCSS) working for components written in TypeScript rendered both inside and outside of Storybook.
|
|
|
|
## Preview
|
|
|
|
Preview the example live on [StackBlitz](http://stackblitz.com/):
|
|
|
|
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-storybook-styled-jsx-scss)
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-storybook-styled-jsx-scss&project-name=with-storybook-styled-jsx-scss&repository-name=with-storybook-styled-jsx-scss)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-storybook-styled-jsx-scss with-storybook-styled-jsx-scss-app
|
|
# or
|
|
yarn create next-app --example with-storybook-styled-jsx-scss with-storybook-styled-jsx-scss-app
|
|
```
|
|
|
|
### Run Storybook
|
|
|
|
```bash
|
|
npm run storybook
|
|
# or
|
|
yarn storybook
|
|
```
|
|
|
|
### Build Static Storybook
|
|
|
|
```bash
|
|
npm run build-storybook
|
|
# or
|
|
yarn build-storybook
|
|
```
|
|
|
|
You can use [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) to deploy Storybook. Specify `storybook-static` as the output directory.
|
|
|
|
## Notes
|
|
|
|
This example combines the following examples, with some required extra config added:
|
|
|
|
- [with-storybook](https://github.com/vercel/next.js/tree/canary/examples/with-storybook)
|
|
- [with-styled-jsx-scss](https://github.com/vercel/next.js/tree/canary/examples/with-styled-jsx-scss)
|
|
- [with-typescript](https://github.com/vercel/next.js/tree/canary/examples/with-typescript)
|