https://github.com/markdoc/markdoc-starter
Starter repo for quickly deploying a Markdoc app with Next.js
https://github.com/markdoc/markdoc-starter
Last synced: 11 months ago
JSON representation
Starter repo for quickly deploying a Markdoc app with Next.js
- Host: GitHub
- URL: https://github.com/markdoc/markdoc-starter
- Owner: markdoc
- Created: 2022-05-11T18:03:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T09:44:45.000Z (about 2 years ago)
- Last Synced: 2025-04-05T23:25:27.771Z (12 months ago)
- Language: TypeScript
- Homepage:
- Size: 86.9 KB
- Stars: 88
- Watchers: 3
- Forks: 83
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Full Next.js example
This is a full-featured boilerplate for a creating a documentation website using Markdoc and Next.js.
## Setup
First, clone this repo and install the dependencies required:
```bash
npm install
# or
yarn install
```
Then, run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `index.md`. The page auto-updates as you edit the file.
## Deploy
The quickest way to deploy your own version of this boilerplate is by deploying it with [Vercel](https://vercel.com) or [Netlify](https://www.netlify.com/) by clicking one of the buttons below.
### Deploy with Vercel
[](https://vercel.com/new/clone?repository-url=https://github.com/markdoc/next.js-starter)
### Deploy to Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/markdoc/next.js-starter)