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 |
||
---|---|---|
.. | ||
components | ||
pages | ||
styles | ||
.gitignore | ||
next-env.d.ts | ||
package.json | ||
README.md | ||
tsconfig.json |
ReactMD, Next.js, and Typescript Example
This example sets up a simple ReactMD, Next.js, and Typescript app featuring:
- _variables.scss to override the default
react-md
theme and feature toggles - app.scss global styles that conditionally apply the dark theme based on the user's OS preferences
- a custom _app.tsx that uses a persistent layout
- a reusable Layout.tsx that:
- updates all the icons to use
SVGIcon
s instead ofFontIcon
s - initializes the
Layout
component fromreact-md
with 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.
Preview
Preview the example live on StackBlitz:
Deploy your own
Deploy the example using Vercel:
How to use
Execute create-next-app
with npm or Yarn to bootstrap the example:
npx create-next-app --example with-react-md-typescript with-react-md-typescript-app
# or
yarn create next-app --example with-react-md-typescript with-react-md-typescript-app
Deploy it to the cloud with Vercel (Documentation).