Skip to content

johnpolacek/readme-as-project-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Example app with MDX

This example shows using MDX as top level pages for your next.js app.

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Using create-next-app

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

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

Download manually

Download the example:

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

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with Vercel (Documentation).

About

Basic example of using your README as project docs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published