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

With Markdown example

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-markdown with-markdown
# or
yarn create next-app --example with-markdown with-markdown-app

Download manually

Download the example:

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

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with now (download)

now

The idea behind the example

This example shows the most basic idea behind implementing markdown-in-js, a library that allows you to write markdown that transpiles to React components at build time.