diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..083af4645 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,251 +1,187 @@ --- title: "Quickstart" -description: "Deploy your documentation in minutes" +description: "Get your documentation site running in under 5 minutes" icon: "rocket" --- -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. +Build and deploy beautiful documentation in minutes. This guide walks you through creating your first documentation site from setup to deployment. - -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - +**Prerequisites**: You need a [Mintlify account](https://mintlify.com/start) to get started. -## Getting started +## Create your site -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +Sign up for Mintlify and complete the onboarding flow. Your documentation site deploys automatically to: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +Your site is live immediately. Find the URL in your [dashboard](https://dashboard.mintlify.com/). 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. +## Connect GitHub -### Install the GitHub App +Connect your GitHub repository to enable automatic deployments: -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. +1. Go to **Settings** → **GitHub App** in your dashboard +2. Click **Install GitHub App** +3. Select your organization and repositories +4. Authorize your GitHub account under **Settings** → **My Profile** 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. +## Choose your workflow - - An admin for your GitHub organization may need to authorize your account depending on your organization settings. - +Pick the editing approach that works best for you: -## Editing workflows + + + Edit files locally with your favorite tools + + + Edit directly in your browser with a visual interface + + -Mintlify offers two workflows for creating and maintaining your documentation: +## Local development - - For users who prefer working with existing tools in their local environment. Click to jump to this section. - - - - For users who prefer a visual interface in their web browser. Click to jump to this section. - - -## 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. +Work with documentation files in your local environment alongside your 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 Mintlify CLI to preview changes locally: ```bash npm npm i -g mint ``` - ```bash pnpm pnpm add -g 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: +### Make your first edit -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: +1. Clone your repository from the onboarding process +2. Open `index.mdx` and update the title: ```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" +title: "My Documentation" +description: "Welcome to my docs" --- ``` -### Preview the changes +### Preview locally -To preview the changes locally, run the following command: +Run the development server: ```bash mint dev ``` -Your preview will be available at `localhost:3000`. +Your site runs at `localhost:3000` with live reloading. Mintlify Dev Mintlify Dev -### Push the 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). - -After the deployment completes, your latest update will be available at `.mintlify.app`. +### Deploy changes - - Optionally, skip the web editor workflow and jump to adding a custom domain. - +Push your changes to GitHub. Mintlify automatically builds and deploys your updates. -## Web editor workflow +## Web editor -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. +Edit documentation directly in your browser with a visual interface. -### 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. - +1. Open your [dashboard](https://dashboard.mintlify.com) +2. Click **Editor** in the sidebar - The Mintlify web editor in the visual editor mode - The Mintlify web editor in the visual editor mode + The Mintlify web editor + The Mintlify web editor -### 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. +### Edit content -Then, in the editor, update the title field to "Hello World". - - - Editing in Web Editor - Editing in Web Editor - +Select any file from the sidebar to start editing. The editor provides rich formatting tools and live preview. - The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools. +Type `/` to open the command menu and access components, formatting, and more. -### Publish your changes +### Publish 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. +Click **Publish** to deploy your changes instantly. - Use branches to preview and review changes through pull requests before deploying to your live site. +Use branches for collaborative editing and pull request workflows. -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). +## Add a custom domain -## Adding a custom domain +Replace your `.mintlify.app` domain with your own: -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. +1. Go to **Settings** → **Custom Domain** in your dashboard +2. Enter your domain (e.g., `docs.yourcompany.com`) +3. Add this DNS record with your domain provider: -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. + +| Type | Name | Value | TTL | +|------|------|-------|-----| +| CNAME | docs | cname.mintlify.app | 3600 | +
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. +DNS changes typically take 5-30 minutes but can take up to 48 hours. -## Next steps - -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +## What's next? - - 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! Here's how to make it even better: -## Troubleshooting + + + Change colors, fonts, and styling + + + Structure your content with groups and tabs + + + Use interactive elements like tabs and accordions + + + Generate interactive API references + + -If you encounter issues during the setup process, check these common troubleshooting solutions: +## Need help? - Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file. + Ensure Node.js v19+ is installed and run `mint dev` from your project root directory. - - Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors. + + Check GitHub Actions or deployment logs in your dashboard for build errors. - - Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record. + + Verify DNS records are correct and allow time for propagation. Use [DNSChecker](https://dnschecker.org) to verify.