Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"index",
"quickstart",
"installation",
"editor"
"editor",
"faq"
]
},
{
Expand Down
247 changes: 247 additions & 0 deletions faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
---
title: 'Frequently Asked Questions'
description: 'Find answers to the most common questions about Mintlify'
---

# Frequently Asked Questions

Welcome to our FAQ page! Here you'll find answers to the most commonly asked questions about Mintlify. If you can't find what you're looking for, feel free to reach out to our support team.

## Getting Started

<AccordionGroup>
<Accordion title="What is Mintlify and how does it work?">
Mintlify is a modern documentation platform that helps teams create beautiful, interactive documentation websites. It uses MDX (Markdown + React components) to combine the simplicity of Markdown with the power of React components. You can write your content in Markdown files, configure your site with a simple JSON file, and deploy instantly to get a professional documentation site.
</Accordion>

<Accordion title="How do I get started with Mintlify?">
Getting started is easy! Follow these steps:
1. **Sign up** for a Mintlify account at mintlify.com
2. **Connect your repository** (GitHub, GitLab, or Bitbucket)
3. **Add a mint.json file** to configure your documentation site
4. **Create your first .mdx files** with your content
5. **Deploy automatically** - your site will be live in minutes!

Check out our [Quickstart Guide](/quickstart) for detailed instructions.
</Accordion>

<Accordion title="Do I need coding experience to use Mintlify?">
Not at all! While Mintlify is built for developers, you don't need extensive coding knowledge to create great documentation. If you can write Markdown (which is very simple), you can use Mintlify. Our platform handles all the complex technical aspects like hosting, performance optimization, and responsive design automatically.
</Accordion>

<Accordion title="Can I import existing documentation?">
Yes! Mintlify supports importing from various sources:
- **Existing Markdown files** - Just add them to your repository
- **GitBook** - Use our migration tool to import your content
- **Notion** - Export your pages as Markdown and import them
- **Other platforms** - Most documentation can be converted to Markdown format

Our team can also help with larger migrations - just contact support!
</Accordion>

<Accordion title="How long does it take to set up a documentation site?">
You can have a basic documentation site running in under 10 minutes! Here's the typical timeline:
- **2-3 minutes**: Account setup and repository connection
- **5-10 minutes**: Basic configuration and first pages
- **30-60 minutes**: Customization and styling
- **Few hours to days**: Complete content migration (depending on size)
</Accordion>
</AccordionGroup>

## Features

<AccordionGroup>
<Accordion title="What features does Mintlify offer?">
Mintlify comes packed with powerful features:
- **Interactive components** - Code blocks, tabs, callouts, and more

Check warning on line 56 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L56

Did you really mean 'callouts'?
- **API documentation** - Auto-generated from OpenAPI specs
- **Search functionality** - Fast, intelligent search across all content
- **Analytics integration** - Track user engagement and popular content
- **Custom domains** - Use your own domain for branding
- **Team collaboration** - Multiple editors and review workflows
- **Version control** - Git-based workflow with branch previews
- **Mobile responsive** - Perfect on all devices
- **Dark/light mode** - User preference support
</Accordion>

<Accordion title="Can I customize the look and feel of my documentation?">
Absolutely! Mintlify offers extensive customization options:
- **Brand colors** - Match your company's color scheme
- **Custom logo** - Add your logo to the navigation
- **Typography** - Choose from various font options
- **Layout options** - Sidebar navigation, topbar, and more
- **Custom CSS** - Advanced styling for specific needs
- **Favicon** - Custom favicon for your site
- **Footer customization** - Add links, social media, and more
</Accordion>

<Accordion title="Does Mintlify support API documentation?">
Yes! Mintlify has excellent API documentation support:
- **OpenAPI/Swagger integration** - Import your API specs automatically
- **Interactive API playground** - Users can test endpoints directly
- **Code examples** - Multiple programming languages supported
- **Authentication handling** - API key and OAuth examples
- **Response examples** - Show expected responses
- **SDK generation** - Auto-generate client libraries
</Accordion>

<Accordion title="What integrations are available?">
Mintlify integrates with many popular tools:
- **Version Control**: GitHub, GitLab, Bitbucket
- **Analytics**: Google Analytics, Mixpanel, Amplitude

Check warning on line 91 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L91

Did you really mean 'Mixpanel'?
- **Support**: Intercom, Zendesk, Crisp

Check warning on line 92 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L92

Did you really mean 'Zendesk'?
- **Feedback**: Canny, UserVoice
- **Search**: Algolia integration for advanced search

Check warning on line 94 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L94

Did you really mean 'Algolia'?
- **Deployment**: Vercel, Netlify compatibility

Check warning on line 95 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L95

Did you really mean 'Vercel'?

Check warning on line 95 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L95

Did you really mean 'Netlify'?
- **CMS**: Headless CMS integrations available
</Accordion>

<Accordion title="Is there a search feature?">
Yes! Mintlify includes a powerful search feature that:
- **Indexes all content** automatically
- **Provides instant results** as you type
- **Highlights matches** in context
- **Supports keyboard shortcuts** (⌘K or Ctrl+K)
- **Works offline** once the site is loaded
- **Can be customized** with Algolia for advanced features

Check warning on line 106 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L106

Did you really mean 'Algolia'?
</Accordion>
</AccordionGroup>

## Pricing

<AccordionGroup>
<Accordion title="How much does Mintlify cost?">
Mintlify offers flexible pricing to fit teams of all sizes:
- **Starter Plan**: Free for public repositories and small teams
- **Pro Plan**: $120/month for advanced features and private repos

Check warning on line 116 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L116

Did you really mean 'repos'?
- **Enterprise Plan**: Custom pricing for large organizations

All plans include hosting, SSL certificates, and core features. Visit our [pricing page](https://mintlify.com/pricing) for the most up-to-date information.
</Accordion>

<Accordion title="Is there a free plan available?">
Yes! Our Starter plan is completely free and includes:
- Unlimited public documentation sites
- All core features and components
- Community support
- Basic analytics
- Custom domain support

This is perfect for open-source projects, personal documentation, or trying out the platform.
</Accordion>

<Accordion title="What's included in the Pro plan?">
The Pro plan includes everything in Starter plus:
- **Private repositories** support
- **Advanced analytics** and insights
- **Priority support** with faster response times
- **Team collaboration** features
- **Custom integrations** and webhooks
- **Advanced customization** options
- **White-label options** (remove Mintlify branding)
</Accordion>

<Accordion title="Do you offer discounts for non-profits or educational institutions?">
Yes! We offer special pricing for:
- **Non-profit organizations** - 50% discount on all plans
- **Educational institutions** - Free Pro plan for qualifying schools
- **Open source projects** - Free Pro features for public repos

Check warning on line 148 in faq.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

faq.mdx#L148

Did you really mean 'repos'?
- **Startups** - Special startup pricing available

Contact our sales team to learn more about these programs.
</Accordion>

<Accordion title="Can I change my plan later?">
Absolutely! You can:
- **Upgrade anytime** - Changes take effect immediately
- **Downgrade** - Changes take effect at the next billing cycle
- **Cancel anytime** - No long-term contracts required
- **Pause billing** - For temporary breaks (contact support)

All plan changes are prorated, so you only pay for what you use.
</Accordion>
</AccordionGroup>

## Technical

<AccordionGroup>
<Accordion title="What file formats does Mintlify support?">
Mintlify primarily works with:
- **MDX files** (.mdx) - Markdown with React components
- **Markdown files** (.md) - Standard Markdown
- **JSON configuration** (mint.json) - Site configuration
- **OpenAPI specs** (.yaml, .json) - For API documentation
- **Images** - PNG, JPG, SVG, WebP
- **Videos** - MP4, WebM (embedded or linked)
</Accordion>

<Accordion title="How does deployment work?">
Deployment is automatic and seamless:
1. **Push to your repository** - Any changes trigger a build
2. **Automatic building** - Mintlify processes your files
3. **Global CDN deployment** - Content distributed worldwide
4. **Live in seconds** - Changes appear almost instantly
5. **Branch previews** - Test changes before merging

No manual deployment steps required!
</Accordion>

<Accordion title="What about performance and speed?">
Mintlify is built for speed:
- **Static site generation** - Pre-built pages load instantly
- **Global CDN** - Content served from the nearest location
- **Image optimization** - Automatic compression and format selection
- **Code splitting** - Only load what's needed
- **Caching** - Intelligent caching strategies
- **Core Web Vitals** - Optimized for Google's performance metrics
</Accordion>

<Accordion title="Is my documentation secure?">
Security is a top priority:
- **HTTPS everywhere** - All sites use SSL certificates
- **Private repositories** - Keep sensitive docs private
- **Access controls** - Team-based permissions
- **SOC 2 compliance** - Enterprise-grade security
- **Regular security audits** - Continuous monitoring
- **Data encryption** - At rest and in transit
</Accordion>

<Accordion title="Can I use custom domains?">
Yes! Custom domains are supported on all plans:
- **Subdomain setup** - docs.yourcompany.com
- **Root domain** - yourcompany.com
- **SSL certificates** - Automatically provisioned
- **DNS configuration** - Simple CNAME setup
- **Multiple domains** - Point multiple domains to the same site
</Accordion>

<Accordion title="What happens if I need to migrate away from Mintlify?">
We believe in data portability:
- **Export all content** - Download your MDX/Markdown files
- **Configuration backup** - Save your mint.json settings
- **Asset downloads** - Get all your images and files
- **No vendor lock-in** - Standard formats work anywhere
- **Migration assistance** - Our team can help with the process
</Accordion>

<Accordion title="Do you provide support for custom development?">
Yes! We offer various support options:
- **Community support** - Free help from our community
- **Email support** - Direct help from our team
- **Priority support** - Faster response times for Pro users
- **Custom development** - Paid consulting for special requirements
- **Migration services** - Professional help moving from other platforms
- **Training sessions** - Team onboarding and best practices
</Accordion>
</AccordionGroup>

## Still have questions?

Can't find the answer you're looking for? We're here to help!

- **Contact Support**: Reach out to our support team at [[email protected]](mailto:[email protected])
- **Join our Community**: Connect with other users in our [Discord community](https://discord.gg/mintlify)
- **Schedule a Demo**: Book a personalized demo at [mintlify.com/demo](https://mintlify.com/demo)
- **Check our Status**: Monitor system status at [status.mintlify.com](https://status.mintlify.com)

We typically respond to support requests within 24 hours (much faster for Pro users).