Skip to content
Draft
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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"pages": [
"index",
"quickstart",
"installation-overview",
"installation",
{
"group": "Web editor",
Expand Down
164 changes: 164 additions & 0 deletions installation-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
---
title: "Getting started with Mintlify"
sidebarTitle: "Overview"
description: "Choose the best way to get started building documentation with Mintlify"
icon: "rocket"
---

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

<CardGroup cols={2}>
<Card title="Web editor" icon="mouse-pointer-2" href="/editor/getting-started">
**Recommended for beginners**

Start building immediately in your browser with our intuitive web editor. No setup required.
</Card>

<Card title="Local development" icon="terminal" href="/installation">
**Recommended for developers**

Use the CLI for local development with your preferred code editor and git workflow.
</Card>
</CardGroup>

## Choose your path

### Web editor approach

<Info>
**Perfect for**: Content creators, marketers, technical writers, and anyone who wants to start quickly without setup.
</Info>

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

<Steps>
<Step title="Sign up and connect your repository">
Create a Mintlify account and connect your GitHub repository at [mintlify.com/start](https://mintlify.com/start).
</Step>

<Step title="Start editing">
Use our web editor to create and modify documentation pages with live preview.

<Tip>
The web editor includes syntax highlighting, autocomplete, and real-time collaboration features.
</Tip>
</Step>

<Step title="Publish your changes">
Click **Publish** to deploy your documentation instantly to the web.
</Step>
</Steps>

### Local development approach

<Info>
**Perfect for**: Developers who prefer working locally, teams with complex workflows, or projects requiring custom scripts and automation.
</Info>

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

<Steps>
<Step title="Install Node.js">
Download and install [Node.js](https://nodejs.org/en) (version 16 or later) on your machine.

<Check>
Verify installation by running `node --version` in your terminal.
</Check>
</Step>

<Step title="Install the Mintlify CLI">
Continue to our [CLI installation guide](/installation) for detailed setup instructions.
</Step>

<Step title="Clone your repository">
Clone your documentation repository locally and start the development server.
</Step>
</Steps>

## Comparison: Web editor vs. local development

<Tabs>
<Tab title="Feature comparison">
| Feature | Web editor | Local development |
|---------|------------|-------------------|
| **Setup time** | Instant | ~5 minutes |
| **Internet required** | Yes | No (after setup) |
| **Collaboration** | Real-time | Git-based |
| **Editor features** | Built-in | Your choice |
| **Advanced workflows** | Limited | Full control |
| **Performance** | Good | Excellent |
| **Learning curve** | Minimal | Moderate |
</Tab>

<Tab title="Use cases">
**Choose web editor if you:**
- Want to start immediately without setup
- Primarily write content rather than code
- Work in small teams with simple workflows
- Prefer browser-based tools
- Need real-time collaboration

**Choose local development if you:**
- Are comfortable with command-line tools
- Have existing git-based workflows
- Need custom build processes or scripts
- Work with large documentation sites
- Prefer your own code editor
- Want to work offline
</Tab>
</Tabs>

## Hybrid approach

<Note>
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
</Note>

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

Check warning on line 141 in installation-overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation-overview.mdx#L141

Did you really mean 'Callouts'?
- **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?

<CardGroup cols={2}>
<Card title="Start with web editor" icon="mouse-pointer-2" href="/editor/getting-started">
Jump right in with our browser-based editor
</Card>

<Card title="Set up local development" icon="terminal" href="/installation">
Install the CLI and start developing locally
</Card>
</CardGroup>

<Tip>
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.
</Tip>
2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CLI installation"
sidebarTitle: "Installation"
sidebarTitle: "CLI setup"
description: "Install the CLI to preview and develop your docs locally"
icon: "terminal"
---
Expand Down Expand Up @@ -128,13 +128,13 @@

### Migrating MDX endpoint pages

You can migrate MDX endpoint pages to autogenerated pages from your OpenAPI specification using the following command:

Check warning on line 131 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L131

Did you really mean 'autogenerated'?

```bash
mint migrate-mdx
```

This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/api-playground/migrating-from-mdx) for detailed information.

Check warning on line 137 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L137

Did you really mean 'autogenerated'?

## Formatting

Expand Down