9f9214abe5
This PR updates the docs and examples for `create-next-app` to include pnpm usage.
The following script was used to update every example README:
```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')
for (let example of examples) {
const filename = `./examples/${example}/README.md`
const markdown = fs.readFileSync(filename, 'utf8')
const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
const output = markdown.replace(regex, (yarn, group) => {
const pnpm = `pnpm create next-app -- --example ${group}`
return `${yarn}\n# or\n${pnpm}`
})
fs.writeFileSync(filename, output)
}
```
|
||
|---|---|---|
| .. | ||
| .storybook | ||
| components | ||
| pages | ||
| public | ||
| stories | ||
| styles | ||
| .babelrc | ||
| .gitignore | ||
| next-env.d.ts | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
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.
Deploy your own
Deploy the example using Vercel or preview live with StackBlitz
How to use
Execute create-next-app with npm or Yarn to bootstrap the example:
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
# or
pnpm create next-app -- --example with-storybook-styled-jsx-scss with-storybook-styled-jsx-scss-app
Run Storybook
npm run storybook
# or
yarn storybook
Build Static Storybook
npm run build-storybook
# or
yarn build-storybook
You can use Vercel to deploy Storybook. Specify storybook-static as the output directory.
Notes
This example combines the following examples, with some required extra config added: