rsnext/examples/with-react-md-typescript
Dominic Elm d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples (#25853)
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
2021-06-08 20:45:02 +00:00
..
components [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
pages [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
styles [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
.gitignore [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
next-env.d.ts [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
package.json fix: bump node-sass peer dependency (#21084) 2021-01-14 02:26:01 +00:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00
tsconfig.json Update tsconfig of example to be consistent with default output of next.js (#25581) 2021-06-03 22:31:14 +00:00

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 SVGIcons instead of FontIcons
    • initializes the Layout component from react-md with navigation items

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:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with 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).