diff --git a/quickstart.mdx b/quickstart.mdx index a93e523e7..8cbf2a819 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,89 +1,59 @@ --- title: "Quickstart" description: "Deploy your documentation site and make your first changes." -keywords: ["quickstart", "deploy", "get started", "first steps"] --- -After completing this guide, you will have a live documentation site ready to customize and expand. +Get your documentation site live in minutes. - -**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 site is automatically deployed to: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - - - Mintlify Domain - Mintlify Domain - +Find your URL in the [dashboard](https://dashboard.mintlify.com/). -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. +## Setup GitHub -### Install the GitHub App +Install the GitHub App to automatically deploy changes: -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +1. Go to **Settings** > **GitHub App** in your dashboard +2. Click **Install GitHub App** +3. Select your organization and repositories -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. +Then authorize your account: -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. - +1. Go to **Settings** > **My Profile** +2. Click **Authorize GitHub account** -## Editing workflows +## Choose your workflow -Mintlify offers two workflows for creating and maintaining your documentation: +Pick the editing workflow that works best for you: - For users who prefer working with existing tools in their local environment. Click to jump to this section. + Edit locally with your preferred tools and Git - For users who prefer a visual interface in their web browser. Click to jump to this section. + Edit directly in your browser with a visual interface ## 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 locally with your preferred development tools. ### Install the CLI - **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. +**Prerequisite**: Requires [Node.js](https://nodejs.org/en) v19 or higher. -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: - ```bash npm npm i -g mint @@ -94,25 +64,9 @@ To work locally with your documentation, install the Command Line Interface (CLI ``` -### Create a new project - -Run `mint new` to create a new documentation project. See the [CLI installation guide](/installation#create-a-new-project) for details on the command and flags. - -### Edit the documentation - -After setting up your project, you can start editing your documentation files. For example, update the title of the introduction page: - -1. Navigate to your documentation repository. -2. Open `index.mdx` and locate the top of the file: - -```mdx index.mdx ---- -title: "Introduction" -description: "This is the introduction to the documentation" ---- -``` +### Create and edit -3. Update the `title` field to `"Hello World"`. +Run `mint new` to create a new project, then edit your MDX files. For example, open `index.mdx`: ```mdx index.mdx {2} --- @@ -121,133 +75,65 @@ description: "This is the introduction to the documentation" --- ``` -### Preview the changes - -To preview the changes locally, run the following command: +### Preview locally ```bash mint dev ``` -Your preview is available at `localhost:3000`. - - - Mintlify Dev - Mintlify Dev - - -### Push the changes +Your preview runs at `localhost:3000`. -When you are ready to publish your changes, push them to your repository. +### Deploy -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. - +Push your changes to GitHub. Mintlify automatically builds and deploys your site. ## 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: +Edit your docs directly in the browser with a visual interface. -Find and select `index.mdx` in the file explorer. +### Open the editor -Then, in the editor, update the title field to "Hello World". - - - Editing in Web Editor - Editing in Web Editor - +1. Go to your [dashboard](https://dashboard.mintlify.com) +2. Click **Editor** in the sidebar - 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 formatting tools. -### Publish your changes +### Edit and publish -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. +Select any file from the sidebar, make your changes, then click **Publish**. Your changes deploy immediately. - - Use branches to preview and review changes through pull requests before deploying to your live site. - +Learn more in the [web editor documentation](/editor). -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). +## Add a custom domain -## Adding a custom domain +Go to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) and enter your domain (e.g., `docs.yourcompany.com`). -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. +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. - - - 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.vercel-dns.com | 3600 | -
+| CNAME | docs | cname.vercel-dns.com | 3600 | - DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. +DNS changes can take up to 48 hours to propagate. ## 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. + + Customize styling, navigation, and integrations - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. + + Change colors, fonts, and appearance - Structure your documentation with intuitive navigation to help users find what they need. + Structure your documentation - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Use interactive elements like accordions and tabs - Create interactive API references with OpenAPI and AsyncAPI specifications. + Create interactive API docs with OpenAPI - -## 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 up 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. - -