Getting started
Create your first page
Set up your documentation and create your first page
Install the CLI
Install the Mintlify CLI for local development
Choose a theme
Select and customize your documentation theme
Configure navigation
Set up your documentation structure and navigation
Content creation
Format text
Learn Markdown formatting, headers, and links
Add code blocks
Display code with syntax highlighting and options
Use components
Add interactive components like accordions and tabs
Add callouts
Highlight important information with callouts
Organization
Configure page metadata
Set titles, descriptions, and frontmatter
Organize with groups
Structure content with navigation groups
Add tabs
Create separate documentation sections with tabs
Configure settings
Customize global documentation settings
API documentation
Set up OpenAPI
Generate API docs from OpenAPI specifications
Create API pages
Build interactive API playgrounds
Configure authentication
Set up API authentication methods
Add MDX content
Enhance API pages with custom content
Customization
Customize colors
Set your brand colors and theme
Add custom domain
Configure a custom domain for your docs
Configure footer
Customize footer links and content
Add analytics
Track documentation usage with analytics
Deployment
Deploy with GitHub
Connect GitHub for automated deployments
Set up CI checks
Automate linting and validation in CI/CD
Preview changes
Generate preview deployments for pull requests
Configure custom domain
Set up a custom domain for your documentation
Optimization
Improve SEO
Optimize for search engines and social sharing
Add search keywords
Enhance page discoverability in search
Check broken links
Find and fix broken links in your docs
Configure redirects
Set up URL redirects for moved content
Integrations
Add analytics
Integrate Google Analytics, Mixpanel, and more
Enable feedback
Collect user feedback on documentation pages
Configure search
Customize search functionality
Add chat support
Integrate chat support widgets
Troubleshooting
Fix deployment issues
Resolve common GitHub deployment problems
Check broken links
Use the CLI to find broken links
Validate configuration
Ensure your docs.json is properly configured
Debug navigation
Fix navigation structure issues