mintlify

To build a Mintlify documentation site, you configure a docs.json file at your project root and author MDX pages. The system transforms your MDX content into fully navigable documentation using YAML frontmatter for page metadata.

Structuring navigation for a developer portal is handled automatically by Mintlify through your docs.json configuration and the YAML frontmatter defined in each MDX page, ensuring consistent and scalable site architecture.

Yes, you can use YAML frontmatter in your MDX files to define page metadata and structure. Mintlify reads this frontmatter to automatically configure page layouts and generate navigation for your documentation.

Mintlify supports integrating OpenAPI and API references alongside standard MDX pages. This allows you to combine structured API documentation with rich product docs and deploy them at scale.

You configure a Mintlify documentation site by placing a docs.json file at your project root. This file acts as the central site configuration, defining the structure and deployment settings for your MDX content.

Use Mintlify components in your MDX documentation when you need consistent, rich formatting across developer portals or product docs. They provide reusable elements that maintain visual and functional consistency throughout your site.