Use this page when you want to run and maintain the docs locally.

​
Prerequisites

  • Node.js installed
  • Mintlify CLI available through npx mint
  • This folder open as the docs root

​
Preview locally

1

Open the docs folder

cd /Users/wupxy/WORK/Code/website/wupxy-portfolio/wupxy-docs
2

Start Mintlify

npx mint dev
3

Check links before publishing

npx mint broken-links

​
Page convention

Create new pages as .mdx files with title and description frontmatter. 
---
title: "Page title"
description: "What the reader can do after reading this page."
---
Then add the page path to docs.json so it appears in navigation.