Interactive CLI for creating and managing Mintlify documentation with the latest docs.json schema, featuring advanced versioning and project structure management.

• Interactive Configuration - Step-by-step wizard for docs.json files
• Enhanced Versioning - Production-grade documentation versioning system
• Migration Tools - Convert from GitBook, Notion, Docusaurus, and other platforms
• Cross-Platform - Works on Windows, macOS, and Linux
• Modern Schema - Full support for 2024-2025 docs.json format
• External Integration - GitHub changelog sync and automated workflows

# Use directly (recommended)
npx mintlifier <command>

# Or install globally
npm install -g mintlifier

npx mintlifier init              # Create new documentation
npx mintlifier versioning       # Setup versioning system
npx mintlifier edit [path]       # Edit existing docs.json
npx mintlifier freeze            # Freeze current version
npx mintlifier auto              # Generate automatically

npx mintlifier init

Follow prompts to configure:

• Name and branding
• Theme (mint, maple, palm, willow, linden, almond, aspen)
• Colors and styling
• Navigation structure
• API documentation
• Analytics and features

docs/
├── docs.json           # Configuration
├── introduction.mdx    # Sample pages
├── getting-started.mdx
├── images/            # Assets
└── snippets/          # Shared components

cd docs
npx mint@latest dev

Enable documentation versioning for release management:

npx mintlifier versioning

Initial Setup:

npx mintlifier init              # Create docs
npx mintlifier versioning       # Enable versioning

Development Cycle:

# Work on documentation in docs/next/ (working directory)
# When ready to release v1.0.0:
npx mintlifier freeze
# Enter current version: v1.0.0
# Enter next version: v1.1.0

Result Structure:

project/
├── docs.json              # Version-aware navigation
├── versions.json          # Version registry
├── docs/
│   ├── next/              # Active development (v1.1.0)
│   │   ├── introduction.mdx
│   │   └── getting-started.mdx
│   └── v1.0.0/            # Frozen v1.0.0 docs
│       ├── introduction.mdx
│       └── getting-started.mdx
├── snippets/              # Shared components
└── images/                # Shared assets

• Historical Accuracy - Frozen versions preserve exact documentation state
• Active Development - Continue working on next version without affecting released docs
• External Changelog - Automatically sync release notes from GitHub
• CI/CD Integration - Automated version freezing on releases

Simple Pages:

{
  "navigation": {
    "pages": ["intro", "guide", "api"]
  }
}

Grouped:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["intro", "setup"]
      }
    ]
  }
}

Versioned (Recommended):

{
  "navigation": {
    "versions": [
      {
        "version": "next",
        "default": true,
        "tabs": [
          {
            "tab": "Documentation",
            "groups": [
              {
                "group": "Getting Started", 
                "pages": ["docs/next/intro", "docs/next/setup"]
              }
            ]
          }
        ]
      },
      {
        "version": "v1.0.0",
        "tabs": [
          {
            "tab": "Documentation",
            "groups": [
              {
                "group": "Getting Started",
                "pages": ["docs/v1.0.0/intro", "docs/v1.0.0/setup"]
              }
            ]
          }
        ]
      }
    ]
  }
}

• mint - Default modern
• maple - Clean professional
• palm - Vibrant tropical
• willow - Soft elegant
• linden - Nature inspired
• almond - Warm inviting
• aspen - Cool minimal

• Google Analytics 4
• PostHog
• Mixpanel
• Amplitude
• Segment
• Heap, Clearbit, Fathom, Hotjar, Koala, Plausible, LogRocket, Pirsch

• Lucide (recommended)
• Heroicons
• Font Awesome
• Tabler
• Phosphor

# Auto-detect structure and setup versioning
npx mintlifier versioning

Supports these structures:

• Root-level docs.json
• docs/ subdirectory
• content/ subdirectory
• Monorepo packages/docs

GitBook:

1. Export as Markdown from GitBook
2. Extract files
3. Run conversion:

npx mintlifier migrate --from gitbook --input ./exported-files

Notion:

1. Export workspace as Markdown & CSV
2. Extract files
3. Convert:

npx mintlifier migrate --from notion --input ./exported-files

Docusaurus/VuePress:

npx mintlifier migrate --from docusaurus
npx mintlifier migrate --from vuepress

Configure OpenAPI integration:

{
  "openapi": "/openapi.json",
  "api": {
    "baseUrl": "https://api.example.com",
    "auth": {
      "method": "bearer"
    },
    "playground": {
      "mode": "show"
    }
  }
}

Enable automated versioning:

name: Freeze Documentation Version
on:
  release:
    types: [published]
jobs:
  freeze-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '18'
      - name: Freeze version
        run: |
          npx mintlifier freeze \
            --version ${{ github.event.release.tag_name }} \
            --next-version "v${{ steps.next.outputs.version }}" \
            --automated

# Generate config automatically
npx mintlifier auto --name "API Docs" --output docs

# Deploy
cd docs
npx mint@latest deploy

Invalid Version Format: Use semantic versioning: v1.0.0, v1.1.0, v2.0.0

Navigation Broken: Use relative paths: /guide not ../guide.md

Version Already Exists: Frozen versions are immutable. Use different version number.

Missing Files: Ensure all documentation files are committed before freezing.

npx mintlifier init
# Follow prompts
# Result: Complete Mintlify project ready for development

npx mintlifier auto --name "API Docs"
# Result: Enterprise-grade API documentation with OpenAPI integration

npx mintlifier versioning
# Setup versioning system
npx mintlifier freeze
# Freeze current version when ready to release

• Node.js ≥ 18.0.0
• npm or yarn

• Repository: https://github.com/Cordtus/mintlifier
• Issues: https://github.com/Cordtus/mintlifier/issues
• Mintlify: https://mintlify.com/docs