Welcome to Mintlify! You have multiple ways to start building beautiful documentation. Choose the approach that best fits your workflow and technical requirements.

​
Quick start options

Web editor

Recommended for beginnersStart building immediately in your browser with our intuitive web editor. No setup required.

Local development

Recommended for developersUse the CLI for local development with your preferred code editor and git workflow.

​
Choose your path

​
Web editor approach

Perfect for: Content creators, marketers, technical writers, and anyone who wants to start quickly without setup.
The web editor provides a complete documentation authoring experience directly in your browser:
  • Zero setup: Start writing immediately without installing anything
  • Live preview: See changes instantly as you type
  • Git integration: Automatically syncs with your GitHub repository
  • Collaborative editing: Multiple team members can edit simultaneously
  • Built-in publishing: Deploy changes with a single click
1

Sign up and connect your repository

Create a Mintlify account and connect your GitHub repository at mintlify.com/start.
2

Start editing

Use our web editor to create and modify documentation pages with live preview.
The web editor includes syntax highlighting, autocomplete, and real-time collaboration features.
3

Publish your changes

Click Publish to deploy your documentation instantly to the web.

​
Local development approach

Perfect for: Developers who prefer working locally, teams with complex workflows, or projects requiring custom scripts and automation.
Local development gives you full control over your documentation workflow:
  • Your preferred editor: Use VS Code, Cursor, Windsurf, or any editor you love
  • Git workflow: Standard branching, pull requests, and version control
  • Advanced features: Custom scripts, automated testing, and CI/CD integration
  • Offline editing: Work without an internet connection
  • Performance: Faster for large documentation sites
1

Install Node.js

Download and install Node.js (version 16 or later) on your machine.
Verify installation by running node --version in your terminal.
2

Install the Mintlify CLI

Continue to our CLI installation guide for detailed setup instructions.
3

Clone your repository

Clone your documentation repository locally and start the development server.

​
Comparison: Web editor vs. local development

FeatureWeb editorLocal development
Setup timeInstant~5 minutes
Internet requiredYesNo (after setup)
CollaborationReal-timeGit-based
Editor featuresBuilt-inYour choice
Advanced workflowsLimitedFull control
PerformanceGoodExcellent
Learning curveMinimalModerate

​
Hybrid approach

You’re not locked into one approach! Many teams use both methods:
  • Content creators use the web editor for writing and editing
  • Developers use local development for structure, configuration, and complex changes
  • Everyone benefits from automatic git synchronization between approaches
Both methods work with the same underlying MDX files and docs.json configuration, so you can switch between them seamlessly.

​
What’s included with Mintlify

Regardless of which approach you choose, you get access to all Mintlify features:
  • Modern components: Callouts, tabs, accordions, code groups, and more
  • API documentation: Auto-generated from OpenAPI specifications
  • Authentication: Restrict access with custom login flows
  • Analytics: Built-in insights and integration with popular tools
  • Custom domains: Host documentation on your own domain
  • SEO optimization: Automatic sitemap generation and meta tags
  • Search: Full-text search across your entire documentation
  • Themes: Beautiful, customizable designs that match your brand

​
Ready to begin?

Start with web editor

Jump right in with our browser-based editor

Set up local development

Install the CLI and start developing locally
If you’re not sure which approach to choose, we recommend starting with the web editor. You can always switch to local development later as your needs grow.