https://github.com/ull-esit-pl/markdoc-starter
first steps with markdoc and next.js
https://github.com/ull-esit-pl/markdoc-starter
markdoc nextjs static-site-generator
Last synced: about 1 month ago
JSON representation
first steps with markdoc and next.js
- Host: GitHub
- URL: https://github.com/ull-esit-pl/markdoc-starter
- Owner: ULL-ESIT-PL
- Created: 2023-12-24T11:50:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T13:52:43.000Z (over 2 years ago)
- Last Synced: 2025-10-29T16:42:54.332Z (8 months ago)
- Topics: markdoc, nextjs, static-site-generator
- Language: TypeScript
- Homepage: https://github.com/markdoc/markdoc-starter
- Size: 45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- 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. But if you are using the free version the repo has to be in your own GitHub account not in an organization and must be public.
### Deploy with Vercel
[](https://vercel.com/new/)
### Deploy to Netlify
It will deploy [crguezl/markdoc-starter](https://github.com/crguezl/markdoc-starter):
[](https://app.netlify.com/start/deploy?repository=https://github.com/crguezl/markdoc-starter)
## References
- See [Using Markdoc with Next.js](https://markdoc.dev/docs/nextjs)
- [Charlie Gerard interview: How Stripe Powers Their Documentation with MarkDoc](https://youtu.be/M1E0dUVuC48?si=nhtYYwOv12HRLzNS) GitHub channel in Youtube. - Open Source Friday #opensource
- See [Dinesh Pandiyan - Markdoc: What is it and why do I love it?](https://youtu.be/XIw-0fCpP_4?si=POxU243rzlm1e71K)
- [How Stripe builds interactive docs with Markdoc](https://stripe.com/blog/markdoc) by Ryan Paul September 13, 2022
- [Building Markdoc: A Powerful, Flexible Open Source Markdown Framework - Mike BiFulco](https://youtu.be/hH_pZTIS_-o?si=ox8v--KSAA9xRN2q) 28 December 2022
- [Getting started with Markdoc in Next.js](https://dev.to/stripe/getting-started-with-markdoc-in-nextjs-ioj). Charlie Gerard for Stripe
- [nextmv-io/docs-code-example](https://github.com/nextmv-io/docs-code-example)