Skip to content

Commit 6bc42ff

Browse files
Add new FAQ page with common questions and answers
1 parent 298bd17 commit 6bc42ff

File tree

1 file changed

+247
-0
lines changed

1 file changed

+247
-0
lines changed

faq.mdx

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
---
2+
title: 'Frequently Asked Questions'
3+
description: 'Find answers to the most common questions about Mintlify'
4+
---
5+
6+
# Frequently Asked Questions
7+
8+
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.
9+
10+
## Getting Started
11+
12+
<AccordionGroup>
13+
<Accordion title="What is Mintlify and how does it work?">
14+
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.
15+
</Accordion>
16+
17+
<Accordion title="How do I get started with Mintlify?">
18+
Getting started is easy! Follow these steps:
19+
1. **Sign up** for a Mintlify account at mintlify.com
20+
2. **Connect your repository** (GitHub, GitLab, or Bitbucket)
21+
3. **Add a mint.json file** to configure your documentation site
22+
4. **Create your first .mdx files** with your content
23+
5. **Deploy automatically** - your site will be live in minutes!
24+
25+
Check out our [Quickstart Guide](/quickstart) for detailed instructions.
26+
</Accordion>
27+
28+
<Accordion title="Do I need coding experience to use Mintlify?">
29+
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.
30+
</Accordion>
31+
32+
<Accordion title="Can I import existing documentation?">
33+
Yes! Mintlify supports importing from various sources:
34+
- **Existing Markdown files** - Just add them to your repository
35+
- **GitBook** - Use our migration tool to import your content
36+
- **Notion** - Export your pages as Markdown and import them
37+
- **Other platforms** - Most documentation can be converted to Markdown format
38+
39+
Our team can also help with larger migrations - just contact support!
40+
</Accordion>
41+
42+
<Accordion title="How long does it take to set up a documentation site?">
43+
You can have a basic documentation site running in under 10 minutes! Here's the typical timeline:
44+
- **2-3 minutes**: Account setup and repository connection
45+
- **5-10 minutes**: Basic configuration and first pages
46+
- **30-60 minutes**: Customization and styling
47+
- **Few hours to days**: Complete content migration (depending on size)
48+
</Accordion>
49+
</AccordionGroup>
50+
51+
## Features
52+
53+
<AccordionGroup>
54+
<Accordion title="What features does Mintlify offer?">
55+
Mintlify comes packed with powerful features:
56+
- **Interactive components** - Code blocks, tabs, callouts, and more
57+
- **API documentation** - Auto-generated from OpenAPI specs
58+
- **Search functionality** - Fast, intelligent search across all content
59+
- **Analytics integration** - Track user engagement and popular content
60+
- **Custom domains** - Use your own domain for branding
61+
- **Team collaboration** - Multiple editors and review workflows
62+
- **Version control** - Git-based workflow with branch previews
63+
- **Mobile responsive** - Perfect on all devices
64+
- **Dark/light mode** - User preference support
65+
</Accordion>
66+
67+
<Accordion title="Can I customize the look and feel of my documentation?">
68+
Absolutely! Mintlify offers extensive customization options:
69+
- **Brand colors** - Match your company's color scheme
70+
- **Custom logo** - Add your logo to the navigation
71+
- **Typography** - Choose from various font options
72+
- **Layout options** - Sidebar navigation, topbar, and more
73+
- **Custom CSS** - Advanced styling for specific needs
74+
- **Favicon** - Custom favicon for your site
75+
- **Footer customization** - Add links, social media, and more
76+
</Accordion>
77+
78+
<Accordion title="Does Mintlify support API documentation?">
79+
Yes! Mintlify has excellent API documentation support:
80+
- **OpenAPI/Swagger integration** - Import your API specs automatically
81+
- **Interactive API playground** - Users can test endpoints directly
82+
- **Code examples** - Multiple programming languages supported
83+
- **Authentication handling** - API key and OAuth examples
84+
- **Response examples** - Show expected responses
85+
- **SDK generation** - Auto-generate client libraries
86+
</Accordion>
87+
88+
<Accordion title="What integrations are available?">
89+
Mintlify integrates with many popular tools:
90+
- **Version Control**: GitHub, GitLab, Bitbucket
91+
- **Analytics**: Google Analytics, Mixpanel, Amplitude
92+
- **Support**: Intercom, Zendesk, Crisp
93+
- **Feedback**: Canny, UserVoice
94+
- **Search**: Algolia integration for advanced search
95+
- **Deployment**: Vercel, Netlify compatibility
96+
- **CMS**: Headless CMS integrations available
97+
</Accordion>
98+
99+
<Accordion title="Is there a search feature?">
100+
Yes! Mintlify includes a powerful search feature that:
101+
- **Indexes all content** automatically
102+
- **Provides instant results** as you type
103+
- **Highlights matches** in context
104+
- **Supports keyboard shortcuts** (⌘K or Ctrl+K)
105+
- **Works offline** once the site is loaded
106+
- **Can be customized** with Algolia for advanced features
107+
</Accordion>
108+
</AccordionGroup>
109+
110+
## Pricing
111+
112+
<AccordionGroup>
113+
<Accordion title="How much does Mintlify cost?">
114+
Mintlify offers flexible pricing to fit teams of all sizes:
115+
- **Starter Plan**: Free for public repositories and small teams
116+
- **Pro Plan**: $120/month for advanced features and private repos
117+
- **Enterprise Plan**: Custom pricing for large organizations
118+
119+
All plans include hosting, SSL certificates, and core features. Visit our [pricing page](https://mintlify.com/pricing) for the most up-to-date information.
120+
</Accordion>
121+
122+
<Accordion title="Is there a free plan available?">
123+
Yes! Our Starter plan is completely free and includes:
124+
- Unlimited public documentation sites
125+
- All core features and components
126+
- Community support
127+
- Basic analytics
128+
- Custom domain support
129+
130+
This is perfect for open-source projects, personal documentation, or trying out the platform.
131+
</Accordion>
132+
133+
<Accordion title="What's included in the Pro plan?">
134+
The Pro plan includes everything in Starter plus:
135+
- **Private repositories** support
136+
- **Advanced analytics** and insights
137+
- **Priority support** with faster response times
138+
- **Team collaboration** features
139+
- **Custom integrations** and webhooks
140+
- **Advanced customization** options
141+
- **White-label options** (remove Mintlify branding)
142+
</Accordion>
143+
144+
<Accordion title="Do you offer discounts for non-profits or educational institutions?">
145+
Yes! We offer special pricing for:
146+
- **Non-profit organizations** - 50% discount on all plans
147+
- **Educational institutions** - Free Pro plan for qualifying schools
148+
- **Open source projects** - Free Pro features for public repos
149+
- **Startups** - Special startup pricing available
150+
151+
Contact our sales team to learn more about these programs.
152+
</Accordion>
153+
154+
<Accordion title="Can I change my plan later?">
155+
Absolutely! You can:
156+
- **Upgrade anytime** - Changes take effect immediately
157+
- **Downgrade** - Changes take effect at the next billing cycle
158+
- **Cancel anytime** - No long-term contracts required
159+
- **Pause billing** - For temporary breaks (contact support)
160+
161+
All plan changes are prorated, so you only pay for what you use.
162+
</Accordion>
163+
</AccordionGroup>
164+
165+
## Technical
166+
167+
<AccordionGroup>
168+
<Accordion title="What file formats does Mintlify support?">
169+
Mintlify primarily works with:
170+
- **MDX files** (.mdx) - Markdown with React components
171+
- **Markdown files** (.md) - Standard Markdown
172+
- **JSON configuration** (mint.json) - Site configuration
173+
- **OpenAPI specs** (.yaml, .json) - For API documentation
174+
- **Images** - PNG, JPG, SVG, WebP
175+
- **Videos** - MP4, WebM (embedded or linked)
176+
</Accordion>
177+
178+
<Accordion title="How does deployment work?">
179+
Deployment is automatic and seamless:
180+
1. **Push to your repository** - Any changes trigger a build
181+
2. **Automatic building** - Mintlify processes your files
182+
3. **Global CDN deployment** - Content distributed worldwide
183+
4. **Live in seconds** - Changes appear almost instantly
184+
5. **Branch previews** - Test changes before merging
185+
186+
No manual deployment steps required!
187+
</Accordion>
188+
189+
<Accordion title="What about performance and speed?">
190+
Mintlify is built for speed:
191+
- **Static site generation** - Pre-built pages load instantly
192+
- **Global CDN** - Content served from the nearest location
193+
- **Image optimization** - Automatic compression and format selection
194+
- **Code splitting** - Only load what's needed
195+
- **Caching** - Intelligent caching strategies
196+
- **Core Web Vitals** - Optimized for Google's performance metrics
197+
</Accordion>
198+
199+
<Accordion title="Is my documentation secure?">
200+
Security is a top priority:
201+
- **HTTPS everywhere** - All sites use SSL certificates
202+
- **Private repositories** - Keep sensitive docs private
203+
- **Access controls** - Team-based permissions
204+
- **SOC 2 compliance** - Enterprise-grade security
205+
- **Regular security audits** - Continuous monitoring
206+
- **Data encryption** - At rest and in transit
207+
</Accordion>
208+
209+
<Accordion title="Can I use custom domains?">
210+
Yes! Custom domains are supported on all plans:
211+
- **Subdomain setup** - docs.yourcompany.com
212+
- **Root domain** - yourcompany.com
213+
- **SSL certificates** - Automatically provisioned
214+
- **DNS configuration** - Simple CNAME setup
215+
- **Multiple domains** - Point multiple domains to the same site
216+
</Accordion>
217+
218+
<Accordion title="What happens if I need to migrate away from Mintlify?">
219+
We believe in data portability:
220+
- **Export all content** - Download your MDX/Markdown files
221+
- **Configuration backup** - Save your mint.json settings
222+
- **Asset downloads** - Get all your images and files
223+
- **No vendor lock-in** - Standard formats work anywhere
224+
- **Migration assistance** - Our team can help with the process
225+
</Accordion>
226+
227+
<Accordion title="Do you provide support for custom development?">
228+
Yes! We offer various support options:
229+
- **Community support** - Free help from our community
230+
- **Email support** - Direct help from our team
231+
- **Priority support** - Faster response times for Pro users
232+
- **Custom development** - Paid consulting for special requirements
233+
- **Migration services** - Professional help moving from other platforms
234+
- **Training sessions** - Team onboarding and best practices
235+
</Accordion>
236+
</AccordionGroup>
237+
238+
## Still have questions?
239+
240+
Can't find the answer you're looking for? We're here to help!
241+
242+
- **Contact Support**: Reach out to our support team at [[email protected]](mailto:[email protected])
243+
- **Join our Community**: Connect with other users in our [Discord community](https://discord.gg/mintlify)
244+
- **Schedule a Demo**: Book a personalized demo at [mintlify.com/demo](https://mintlify.com/demo)
245+
- **Check our Status**: Monitor system status at [status.mintlify.com](https://status.mintlify.com)
246+
247+
We typically respond to support requests within 24 hours (much faster for Pro users).

0 commit comments

Comments
 (0)