rsnext/examples/with-react-md-typescript/README.md
JTaylor0196 f7baa56792
update example Deploy button URLs (#48842)
### What?
Updates Deploy button URLs for all listed examples here:
https://github.com/vercel/next.js/tree/canary/examples

### Why?
The Deploy URLs are currently broken and result in a failed clone
attempt on Vercel.

### How?
The URLs have been changed from https://vercel.com/new/git/external?… to
-> https://vercel.com/new/clone?…
(Last updated
[here](8eaabe2fb0)
in 2021)
2023-04-26 13:31:44 -04:00

2.2 KiB

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.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-react-md-typescript with-react-md-typescript-app
yarn create next-app --example with-react-md-typescript with-react-md-typescript-app
pnpm create next-app --example with-react-md-typescript with-react-md-typescript-app

Deploy it to the cloud with Vercel (Documentation).