Prerequisites: - Node.js version 19 or higher - A documentation workspace
with a
docs.json file1
Install the Mintlify CLI
2
Start a local preview
Navigate to the documentation folder and run:Your local preview is available at
http://localhost:3000.Custom ports
Mintlify uses port 3000 by default. Change it with the--port flag when needed.
Validate links before publishing
Run the broken link check before you publish changes.What the guide section covers
Use the guide pages to explain Hostifer onboarding and the docs workflow.Quickstart
Walk through account setup, project creation, and your first deployment.
API introduction
Review auth headers, SSE logs, and webhook expectations.
Docs settings
Understand the docs site configuration in
docs.json.Navigation
Organize the docs sidebar for new pages.
Troubleshooting
The preview does not load
The preview does not load
Make sure you are running
mint dev from the directory that contains docs.json.You see a sample page you no longer want
You see a sample page you no longer want
Remove the page from navigation or replace the starter content with Hostifer content.
Helpful references
Global settings
Learn how the docs site is configured.