1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
next.js/examples/with-markdown/README.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2017-12-07 00:59:32 +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-markdown)
# With Markdown example
## 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:
2017-12-07 00:59:32 +00:00
```bash
npx create-next-app --example with-markdown with-markdown
# or
yarn create next-app --example with-markdown with-markdown-app
2017-12-07 00:59:32 +00:00
```
### Download manually
Download the example [or clone the repo](https://github.com/zeit/next.js):
```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-markdown
2017-12-07 00:59:32 +00:00
cd with-markdown
```
Install it and run:
```bash
npm install
npm run dev
# or
yarn
yarn dev
2017-12-07 00:59:32 +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
This example shows the most basic idea behind implementing [markdown-in-js](https://github.com/threepointone/markdown-in-js), a library that allows you to write markdown that transpiles to React components *at build time*.