diff --git a/quickstart.mdx b/quickstart.mdx index c6ee26b90..68955dacc 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -3,83 +3,25 @@ title: "Quickstart" description: "Deploy your documentation in minutes" --- -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. +Get your documentation site up and running quickly. - -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - +**Prerequisites**: [Create an account](https://mintlify.com/start) and complete onboarding. -## 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 automatically deploys to: ``` https://.mintlify.app ``` -Find your URL on the Overview page of 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. - -### 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. - - - - 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. +Find your URL on the [dashboard](https://dashboard.mintlify.com/) Overview page. -### Install the CLI +## 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 Command Line Interface to work locally: ```bash npm @@ -91,36 +33,21 @@ To work locally with your documentation, install the Command Line Interface (CLI ``` - - 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: +## Edit your documentation -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: +1. Open your repository from onboarding +2. Edit `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" --- ``` -### Preview the changes +## Preview locally -To preview the changes locally, run the following command: +Run this command to preview changes: ```bash mint dev @@ -128,123 +55,30 @@ mint dev Your preview will be available at `localhost:3000`. - - 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`. - - - Optionally, skip the web editor workflow and jump to adding a custom domain. - - -## 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 +## Deploy changes -In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: +Push your changes to your repository. Mintlify automatically builds and deploys your updates. -Find and select `index.mdx` in the file explorer. +## Add a custom domain -Then, in the editor, update the title field to "Hello World". +Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard and add your domain (e.g., `docs.yourcompany.com`). - - 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. +Configure DNS with your provider: | Record Type | Name | Value | TTL | |-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | +| CNAME | docs | 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. - - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. + + Set up navigation, styling, and integrations - - Structure your documentation with intuitive navigation to help users find what they need. + + Enhance with interactive elements - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Create interactive API references - - Create interactive API references with OpenAPI and AsyncAPI specifications. - - -## 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. - -