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)
}
```
|
||
|---|---|---|
| .. | ||
| components | ||
| pages | ||
| styles | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
ReactMD and Next.js Example
This example sets up a simple ReactMD and Next.js app featuring:
- _variables.scss to override the default
react-mdtheme and feature toggles - app.scss global styles that conditionally apply the dark theme based on the user's OS preferences
- a custom _app.jsx that uses a persistent layout
- a reusable Layout.jsx that:
- updates all the icons to use
SVGIcons instead ofFontIcons - initializes the
Layoutcomponent fromreact-mdwith navigation items
- updates all the icons to use
For more information about ReactMD's features, styling, components, and API, check out the main documentation. You can also view the documentation site's source code for a more complex example of using ReactMD + Next.js or the with-react-md-typescript example for Typescript support.
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-react-md with-react-md-app
# or
yarn create next-app --example with-react-md with-react-md-app
# or
pnpm create next-app -- --example with-react-md with-react-md-app
Deploy it to the cloud with Vercel (Documentation).