next.js/examples/with-react-md/README.md

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-react-md)

# Example app with react-md

![Screenshot](https://cloud.githubusercontent.com/assets/304265/22472564/b2e04ff0-e7de-11e6-921e-d0c9833ac805.png)

## How to use

### Using `create-next-app`

Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:

```bash
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
```

### Download manually

Download the example:

```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-react-md
cd with-react-md
```

Install it and run:

```bash
npm install
ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css
npm run dev
# or
yarn
ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css
yarn dev
```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))

```bash
now
```

## The idea behind the example

This example features how you use [react-md](https://react-md.mlaursen.com/) (React Material Design) with Next.js.

I recommend reading [layout-component](../layout-component) example next to learn how to reuse the layout across the pages.
Add deploy now button to the top of all example READMEs (#1763) * Add deploy now button to the top of all example READMEs * Remove unnecessary whitespace changes 2017-04-22 12:51:51 +00:00			`[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-react-md)`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00
			`# Example app with react-md`

fix(example): Added missing instructions for CSS "bundling" in with-react-md example (#1451) (#1456) 2017-03-18 10:45:48 +00:00			`![Screenshot](https://cloud.githubusercontent.com/assets/304265/22472564/b2e04ff0-e7de-11e6-921e-d0c9833ac805.png)`

Added React-MD example (#940) 2017-02-02 12:10:59 +00:00			`## How to use`

examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00			### Using `create-next-app`

Examples: stabalise README format and create-next-app usage (#4009) * Examples: clarify language around Yarn create & npx * add missing READMEs and create-next-app usage * suggest people tag jthegedus in firebase related issues * add yarn alt instructions * cerebraljs example readme & fixes 2018-04-03 12:19:05 +00:00			Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00
Examples: use npx and yarn create to run create-next-app on examples (#4002) * remove global npm install of create-next-app * add npx to create-next-app command in examples * add bash to shell snippets * add yarn create to next-app command in examples * fix READMEs named with lowercase * change READMEs to use UPPERCASE 2018-03-14 08:09:46 +00:00			```bash
			`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`
examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00			```

			`### Download manually`

#4751 - Explicitly mention install when cloning examples (#4758) Preferably this installation wouldn't be necessary, but in lieu of a fix... #4751 2018-07-11 21:56:15 +00:00			`Download the example:`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00
			```bash
Use canary for all example downloads (#3411) 2017-12-07 02:12:42 +00:00			`curl https://codeload.github.com/zeit/next.js/tar.gz/canary \| tar -xz --strip=2 next.js-canary/examples/with-react-md`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00			`cd with-react-md`
			```

			`Install it and run:`

			```bash
			`npm install`
fix(example): Added missing instructions for CSS "bundling" in with-react-md example (#1451) (#1456) 2017-03-18 10:45:48 +00:00			`ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00			`npm run dev`
Examples: stabalise README format and create-next-app usage (#4009) * Examples: clarify language around Yarn create & npx * add missing READMEs and create-next-app usage * suggest people tag jthegedus in firebase related issues * add yarn alt instructions * cerebraljs example readme & fixes 2018-04-03 12:19:05 +00:00			`# or`
			`yarn`
			`ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css`
			`yarn dev`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00			```

			`Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))`

			```bash
			`now`
			```

			`## The idea behind the example`

Fix typo in react-md example readme (#959) 2017-02-02 19:00:45 +00:00			`This example features how you use [react-md](https://react-md.mlaursen.com/) (React Material Design) with Next.js.`
Added React-MD example (#940) 2017-02-02 12:10:59 +00:00
			`I recommend reading [layout-component](../layout-component) example next to learn how to reuse the layout across the pages.`