Skip to content

development.mdx

Latest commit

 

History

History
43 lines (33 loc) · 830 Bytes

development.mdx

File metadata and controls

43 lines (33 loc) · 830 Bytes
Raw
title Docs Development
description Preview and validate the Mintlify documentation locally.

This documentation repo is a Mintlify project. Pages are MDX files, and navigation is defined in docs.json.

Preview locally

npm i -g mint
mint dev

Mintlify starts a local preview, usually at http://localhost:3000. If the port is occupied, it will choose the next available port.

Validate links

mint broken-links

Repository structure

docs.json
index.mdx
quickstart.mdx
features/
guides/
configuration/
deployment/
reference/
images/
logo/

Editing notes

  • Add every public page to docs.json navigation
  • Keep pages original to KeinSaaS Navigator
  • Use README media only when it demonstrates a Navigator feature
  • Run a local preview before pushing major changes