diff --git a/docs.json b/docs.json index ac3b52032..7990004de 100644 --- a/docs.json +++ b/docs.json @@ -22,6 +22,7 @@ "pages": [ "index", "quickstart", + "installation-overview", "installation", { "group": "Web editor", diff --git a/installation-overview.mdx b/installation-overview.mdx new file mode 100644 index 000000000..039d51b26 --- /dev/null +++ b/installation-overview.mdx @@ -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 + + + + **Recommended for beginners** + + Start building immediately in your browser with our intuitive web editor. No setup required. + + + + **Recommended for developers** + + Use 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 + + + + Create a Mintlify account and connect your GitHub repository at [mintlify.com/start](https://mintlify.com/start). + + + + 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. + + + + + 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 + + + + Download and install [Node.js](https://nodejs.org/en) (version 16 or later) on your machine. + + + Verify installation by running `node --version` in your terminal. + + + + + Continue to our [CLI installation guide](/installation) for detailed setup instructions. + + + + Clone your documentation repository locally and start the development server. + + + +## Comparison: Web editor vs. local development + + + +| 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 | + + + +**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 + + + +## 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? + + + + Jump right in with our browser-based editor + + + + 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. + \ No newline at end of file diff --git a/installation.mdx b/installation.mdx index 988d4e196..ead0b9728 100644 --- a/installation.mdx +++ b/installation.mdx @@ -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" ---