CodeLeom / markdoc-test

This is a documentation page developed using markdoc and NextJS. Which can be used internally for team to document their codes, it can also be deployed for public API.

MarkDoc Documentation deployment for Teams

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:

npm install
# or
yarn install

Then, run the development server:

npm run dev
# or
yarn dev

Open 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.

Contribute

To contribute to this documentation page, create a new branch, and make your PR to the dev branch. Any PR to the Main branch will be rejected.

To add a new page, go to the docs folder (placed inside the pages folder), create a new .md file with your desired title, populate with the content and save.

To add the page to the page, go to the component folder, open the sideNav component, then add it as a children to the get started array.

Test locally, and if your changes is fine, make the push to the dev branch and raise a PR.

Deploy

The quickest way to deploy your own version of this boilerplate is by deploying it with Vercel or Netlify by clicking one of the buttons below.

Deploy with Vercel

Deploy to Netlify