diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..5a093a2b3 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,251 +1,196 @@ --- title: "Quickstart" -description: "Deploy your documentation in minutes" +description: "Deploy beautiful documentation 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. +Deploy your documentation site and start creating beautiful docs in just a few minutes. - -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - +**Before you begin**: Create your [Mintlify account](https://mintlify.com/start) and complete the onboarding process. -## Getting started +## Your site is live -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +After onboarding, your documentation is automatically deployed at: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - - - Mintlify Domain - Mintlify Domain - + +Your documentation site is already live and ready to share with your team. + -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. +Find your exact URL in the [dashboard](https://dashboard.mintlify.com/) Overview page. - GitHub App Installation - GitHub App Installation + Live documentation URL in dashboard + Live documentation URL in dashboard - - 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: +## Choose your workflow - - For users who prefer working with existing tools in their local environment. Click to jump to this section. + + + Visual editing in your browser. No setup required. - - For users who prefer a visual interface in their web browser. Click to jump to this section. + + Local development with 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: +## Web editor workflow - - ```bash npm - npm i -g mint +The fastest way to create and edit documentation. + + + + Navigate to **Editor** in your [dashboard](https://dashboard.mintlify.com). + + + The GitHub App will install automatically when you first open the editor. + + + + + Select `index.mdx` and change the title to "Hello Mintlify". + + + Editing documentation in the web editor + Editing documentation in the web editor + + + + Press / in the editor to access components, formatting, and more. + + + + + Select **Publish** to deploy your changes instantly. + + + Your changes are now live at your documentation URL. + + + + +## Code-based workflow + +For teams who prefer local development and Git workflows. + + + + + ```bash npm + npm i -g mint + ``` + + ```bash pnpm + pnpm add -g mint + ``` + + + + Requires Node.js 19+. Having trouble? Check our [troubleshooting guide](#troubleshooting). + + + + + In your dashboard: + 1. Go to **Settings** → **GitHub App** + 2. Select **Install GitHub App** + 3. Choose your repositories + + + Admin approval may be required for organization repositories. + + + + + Clone your repository and make changes: + + ```mdx index.mdx + --- + title: "Hello Mintlify" + description: "Welcome to our documentation" + --- ``` - ```bash pnpm - pnpm add -g mint + Preview changes with: + ```bash + mint dev ``` - - - - 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" ---- -``` + + Your preview is available at `localhost:3000`. + + -### Preview the changes + + Push to your repository. Mintlify automatically builds and deploys your updates. -To preview the changes locally, run the following command: + + Monitor deployment status in GitHub Actions or your dashboard. + + + -```bash -mint dev -``` +## Add a custom domain -Your preview will be available at `localhost:3000`. +Ready to use your own domain? Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. - - Mintlify Dev - Mintlify Dev - + + + Add your domain (like `docs.yourcompany.com`). + -### Push the changes + + Add this CNAME record with your DNS provider: -When you are ready to publish your changes, push them to your repository. + | Record | Name | Value | TTL | + |--------|------|-------|-----| + | CNAME | docs | cname.mintlify.app | 3600 | -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). + + DNS changes can take up to 48 hours, but often complete within minutes. + + + -After the deployment completes, your latest update will be available at `.mintlify.app`. +## What's next? - - Optionally, skip the web editor workflow and jump to adding a custom domain. + + + Configure colors, fonts, and styling to match your brand. -## 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 - -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. - - - - 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. - - - Use branches to preview and review changes through pull requests before deploying to your live site. - - -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 - -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. - -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. - - - 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 - -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: - - - Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. + + Structure your documentation with intuitive navigation. - - 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. + + + Enhance content with interactive components and code samples. - - Create interactive API references with OpenAPI and AsyncAPI specifications. + + + Create interactive API references with OpenAPI specs. +
## Troubleshooting -If you encounter issues during the setup process, check these common troubleshooting solutions: - - - Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file. - - - 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. - - - 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. - - + +Ensure you have Node.js 19+ and run `mint dev` from your docs directory containing `docs.json`. + + + +Deployment takes 1-3 minutes. Check GitHub Actions or dashboard logs for build errors. + + + +Verify DNS records are correct and allow time for propagation. Use [DNSChecker](https://dnschecker.org) to verify your CNAME. + + \ No newline at end of file