diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..4d9854471 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,251 +1,220 @@ --- title: "Quickstart" -description: "Deploy your documentation in minutes" +description: "Get your documentation site live in under 10 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. - +**Before you start**: You'll need a [Mintlify account](https://mintlify.com/start). The onboarding process creates your first project automatically. -## Getting started +## Your site is already live -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +Once you complete onboarding, your documentation site is automatically deployed at: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +You can find this URL on your [dashboard overview](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 your GitHub repository -### Install the GitHub App - -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +Link your GitHub repository to enable automatic deployments when you push changes. -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. +### Install the GitHub App -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. Complete the installation GitHub App Installation GitHub App Installation - - Update the GitHub App permissions if you move your documentation to a different repository. - - -### Authorize your GitHub account +### Authorize your 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. Navigate to **Settings** → **My Profile** +2. Click **Authorize GitHub account** +3. Complete the authorization flow -## Editing workflows + +Organization admins may need to approve the authorization depending on your GitHub settings. + -Mintlify offers two workflows for creating and maintaining your documentation: +## Choose your editing workflow - - For users who prefer working with existing tools in their local environment. Click to jump to this section. - +Pick the workflow that matches how you prefer to work: - - For users who prefer a visual interface in their web browser. Click to jump to this section. - + + + Edit files locally with your favorite tools and Git workflow + + + Edit directly in your browser with a visual interface + + -## Code-based workflow +## Local development -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 your documentation files locally using familiar development tools. ### 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 npm +npm i -g mint +``` - ```bash pnpm - pnpm add -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. - + +Requires Node.js v19 or higher. Check your version with `node --version`. + -### Edit the documentation +### Make your first edit -After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: +Let's update your homepage: -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: +1. Open `index.mdx` in your repository +2. Change the title in the frontmatter: ```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: "Welcome to our docs" +description: "Everything you need to get started" --- ``` -### Preview the changes +### Preview locally -To preview the changes locally, run the following command: +Start the development server: ```bash mint dev ``` -Your preview will be available at `localhost:3000`. +Your site will be available at `http://localhost:3000`. - Mintlify Dev - Mintlify Dev + Local preview + Local preview -### Push the changes - -When you are ready to publish your changes, push them to your repository. +### Deploy your changes -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). +Push your changes to GitHub: -After the deployment completes, your latest update will be available at `.mintlify.app`. +```bash +git add . +git commit -m "Update homepage title" +git push +``` - - Optionally, skip the web editor workflow and jump to adding a custom domain. - +Mintlify automatically builds and deploys your changes. Check the deployment status in your GitHub Actions or dashboard. -## 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 your documentation directly in your browser without any local setup. -### 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 + Web editor interface + Web editor interface -### 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 your content -Then, in the editor, update the title field to "Hello World". +1. Select `index.mdx` from the file explorer +2. Update the title field to "Welcome to our docs" +3. Use the formatting toolbar or type `/` for quick commands - Editing in Web Editor - Editing in Web Editor + Editing content + Editing content - - 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 +### Publish instantly -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** in the top-right corner to deploy your changes immediately. - Use branches to preview and review changes through pull requests before deploying to your live site. +Use branches to preview changes before publishing to your live site. 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 - -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. +## Add a custom domain -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 - +Replace your `.mintlify.app` subdomain with your own domain. -Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider. +1. Go to **Settings** → **Custom Domain** in your dashboard +2. Enter your domain (e.g., `docs.yourcompany.com`) +3. Add this CNAME record to your DNS: | Record Type | Name | Value | TTL | |-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | +| CNAME | docs | cname.mintlify.app | 3600 |
+ + Custom domain setup + Custom domain setup + + - 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 to fully propagate. -## Next steps +## What's next? -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +Your documentation site is now live and ready to customize. Here are the most important next steps: - - 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. - + + + Set up your site's global configuration, branding, and integrations + + + Structure your content with clear navigation and page hierarchy + + + Apply your brand colors, fonts, and styling preferences + + + Enhance your content with interactive elements and rich formatting + + -## Troubleshooting - -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 you have Node.js v19+ installed and run `mint dev` from the directory containing your `docs.json` file. + + + Check your GitHub Actions for build errors. Deployments typically take 1-3 minutes to complete. - - 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 your CNAME record is correct and allow time for DNS propagation. Use [DNSChecker](https://dnschecker.org) to verify your setup. - - 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. + + Visit our [support page](/contact-support) or reach out to our team directly. - + \ No newline at end of file