Mintlify Blueprint Repository

Select 'Use this template' to initiate a new project based on the Mintlify starter architecture. This foundational structure provides working examples covering:

• Instructional documentation sections
• Site map definitions and hierarchy
• Theming and stylistic modifications
• Integrated API reference material
• Implementation examples of common UI elements

Local Development Setup

To enable real-time previewing of documentation modifications on your workstation, install the official Mintlify Command-Line Interface (CLI). Installation is performed via this command:

npm i -g mintlify

Navigate to the root directory of your documentation source (where the mint.json configuration file resides) and execute the development server command:

mintlify dev

Continuous Integration and Deployment

Integrate our dedicated GitHub Application to manage the seamless propagation of repository updates to the live deployment endpoint. Once changes are committed and pushed to the designated primary branch, deployment to the production environment occurs automatically. Installation access can be obtained through your project dashboard link.

Troubleshooting Common Issues

• 'mintlify dev' fails to initiate: Attempt running mintlify install to refresh and reconcile necessary project dependencies.
• Content displays as a 404 Error: Verify that the command execution path is the correct directory containing the mandatory mint.json configuration manifest.