diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..0d223fb72 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,86 +1,114 @@ --- title: "Quickstart" -description: "Deploy your documentation in minutes" -icon: "rocket" +description: "From zero to deployed docs in under 5 minutes" +icon: "zap" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. - -After completing this guide, you will have a live documentation site ready to customize and expand. + + Transform your ideas into beautiful, interactive documentation in minutes, not hours. + - +## What you'll accomplish -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. + + + Your docs will be instantly available at a custom URL + + + Pick between code-first or visual editing + + + Add your custom domain and branding + + + +**Before you start**: [Create your account](https://mintlify.com/start) and complete the quick onboarding flow. -## Getting started - -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +## 🎯 Step 1: Your site is live! -``` -https://.mintlify.app -``` - -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). + + Your documentation site is automatically deployed during onboarding to: + + ``` + https://.mintlify.app + ``` + Mintlify Domain Mintlify Domain -Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site. - -### Install the GitHub App - -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. - -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. - -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **GitHub App** from the sidebar. -3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page. -4. Select the organization or user account where you want to install the app. -5. Select the repositories that you want to connect. - - - GitHub App Installation - GitHub App Installation - - - - Update the GitHub App permissions if you move your documentation to a different repository. - - -### Authorize your GitHub account - -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **My Profile** from the sidebar. -3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page. - - - An admin for your GitHub organization may need to authorize your account depending on your organization settings. - - -## Editing workflows - -Mintlify offers two workflows for creating and maintaining your documentation: - - - For users who prefer working with existing tools in their local environment. Click to jump to this section. - + +**Pro tip**: Bookmark your dashboard URL! You'll find your site link on the Overview page of your [dashboard](https://dashboard.mintlify.com/). + - - For users who prefer a visual interface in their web browser. Click to jump to this section. +### πŸ”— Connect GitHub for auto-deployment + + + + + + Navigate to **Settings** β†’ **GitHub App** in your dashboard + + + Click **Install GitHub App** to open the installation page + + + Select your organization and the repositories to connect + + + + + GitHub App Installation + GitHub App Installation + + + + + + + Navigate to **Settings** β†’ **My Profile** + + + Click **Authorize GitHub account** + + + Follow the GitHub authorization flow + + + + + Your GitHub organization admin may need to approve the authorization. + + + + +## πŸ› οΈ Step 2: Choose your editing workflow + + + + **Perfect for developers** + + Work locally with your favorite editor, Git workflows, and CLI tools. + + + + **Perfect for teams** + + Edit directly in your browser with real-time preview and collaboration. + + + +## πŸ‘¨β€πŸ’» Code-based workflow + + + Perfect for teams who want to manage docs alongside code with full Git integration. -## Code-based workflow - -The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code. - -### Install the CLI - -To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: +### πŸ“¦ Install the CLI ```bash npm @@ -90,150 +118,227 @@ To work locally with your documentation, install the Command Line Interface (CLI ```bash pnpm pnpm add -g mint ``` + + ```bash yarn + yarn global add mint + ``` - - You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide. - - -### Edit the documentation - -After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: - -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: - -```mdx index.mdx ---- -title: "Introduction" -description: "This is the introduction to the documentation" ---- -``` - -3. Update the `title` field to `"Hello World"`. - -```mdx index.mdx {2} ---- -title: "Hello World" -description: "This is the introduction to the documentation" ---- -``` - -### Preview the changes - -To preview the changes locally, run the following command: + +**Requirements**: Node.js v19+ is required. [Download here](https://nodejs.org/) if needed. + + +### ✏️ Make your first edit + +Let's update your homepage to see the magic in action: + + + + Navigate to the repository created during onboarding + + + Find the frontmatter at the top: + ```mdx index.mdx + --- + title: "Introduction" + description: "This is the introduction to the documentation" + --- + ``` + + + Change it to something exciting: + ```mdx index.mdx {2} + --- + title: "Welcome to our docs! πŸŽ‰" + description: "This is the introduction to the documentation" + --- + ``` + + + +### πŸ‘€ Preview locally + +Start the development server: ```bash mint dev ``` -Your preview will be available at `localhost:3000`. + + Your docs are now live at `localhost:3000` with hot reload enabled. + Mintlify Dev Mintlify Dev -### Push the changes +### πŸš€ Deploy your changes + + + + ```bash + git add . + git commit -m "Update homepage title" + ``` + + + ```bash + git push origin main + ``` + + + Mintlify automatically builds and deploys your changes! + + -When you are ready to publish your changes, push them to your repository. - -Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com). + +Monitor deployment status in your [dashboard](https://dashboard.mintlify.com) or GitHub Actions tab. + -After the deployment completes, your latest update will be available at `.mintlify.app`. +## ✨ Web editor workflow - - Optionally, skip the web editor workflow and jump to adding a custom domain. + + Perfect for content creators and teams who prefer visual editing with instant preview. -## Web editor workflow - -The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools. - -### Access the web editor +### 🌐 Access the editor -1. Log in to your [dashboard](https://dashboard.mintlify.com). -2. Select **Editor** on the left sidebar. - - - If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor. - + + + Log in to your [dashboard](https://dashboard.mintlify.com) + + + Click **Editor** in the left sidebar + + + Your visual editor is ready to go! + + The Mintlify web editor in the visual editor mode The Mintlify web editor in the visual editor mode -### Edit the documentation - -In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: - -Find and select `index.mdx` in the file explorer. - -Then, in the editor, update the title field to "Hello World". - - - Editing in Web Editor - Editing in Web Editor - - - - The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools. - - -### Publish your changes - -When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. +### ✏️ Make your first edit + + + + 1. Find `index.mdx` in the file explorer + 2. Update the title to "Welcome to our docs! πŸŽ‰" + 3. See your changes instantly in the preview + + + Editing in Web Editor + Editing in Web Editor + + + + + + Type `/` anywhere to open the command menu and access: + - Interactive components + - Code blocks with syntax highlighting + - Tables, callouts, and more + + + + +### πŸš€ Publish instantly + + + Click the **Publish** button in the top-right corner and your changes go live immediately! + - Use branches to preview and review changes through pull requests before deploying to your live site. +**Pro workflow**: Use branches to preview changes and collaborate with pull requests before going live. Learn more in our [web editor guide](/editor/getting-started). -For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor/getting-started). - -## Adding a custom domain +## 🌐 Step 3: Add your custom domain -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. + + Transform `your-project.mintlify.app` into `docs.yourcompany.com` for a professional touch. + -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +### Quick setup + + + + Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard + + + Add your desired domain (e.g., `docs.yourcompany.com`) + + + Add this CNAME record with your domain provider: + + + | Record Type | Name | Value | TTL | + |-------------|------|-------|-----| + | CNAME | docs | cname.mintlify.app | 3600 | +
+
+ + DNS changes typically take 5-30 minutes (up to 48 hours max) + +
Custom Domain Custom Domain -Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider. - - -| Record Type | Name | Value | TTL | -|-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | -
- - - DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. - - -## Next steps + +**Check DNS status**: Use [DNSChecker](https://dnschecker.org) to verify your CNAME record is propagating correctly. + -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +## πŸŽ‰ You're all set! - - Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. - - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. - - - Structure your documentation with intuitive navigation to help users find what they need. - - - Enhance your documentation with interactive components like accordions, tabs, and code samples. - - - Create interactive API references with OpenAPI and AsyncAPI specifications. + + Your documentation site is live and ready to impress. Time to make it uniquely yours! +### What's next? + + + + **Customize themes** + + Colors, fonts, and branding to match your company + + + + **Structure navigation** + + Create intuitive paths for your users + + + + **Global configuration** + + SEO, integrations, and site-wide options + + + + **Interactive elements** + + Tabs, accordions, code blocks, and more + + + + **OpenAPI integration** + + Auto-generate interactive API references + + + + **Analytics dashboard** + + Monitor usage and improve your docs + + + ## Troubleshooting If you encounter issues during the setup process, check these common troubleshooting solutions: