rsnext/examples/with-react-md-typescript
Steven 4466ba436b
chore(examples): use default prettier for examples/templates (#60530)
## Description
This PR ensures that the default prettier config is used for examples
and templates.

This config is compatible with `prettier@3` as well (upgrading prettier
is bigger change that can be a future PR).

## Changes
- Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will
be needed upgrading to prettier@3)
- Added `examples/.prettierrc.json` with default config (this will
change every example)
- Added `packages/create-next-app/templates/.prettierrc.json` with
default config (this will change every template)

## Related

- Fixes #54402
- Closes #54409
2024-01-11 16:01:44 -07:00
..
components chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
pages chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
styles chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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.

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