diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..5be370db8 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,47 +1,46 @@ --- title: "Quickstart" -description: "Deploy your documentation in minutes" +description: "Build beautiful documentation in under 10 minutes" icon: "rocket" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. +Get your documentation site live in minutes with this step-by-step guide. -After completing this guide, you will have a live documentation site ready to customize and expand. +You'll go from zero to a fully deployed documentation site with custom branding and interactive features. -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. +**Before you start**: [Sign up for Mintlify](https://mintlify.com/start) and complete the initial setup wizard. -## Getting started +## Launch your site -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +Once you finish the setup wizard, your documentation automatically goes live at: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +Your unique URL appears 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. +This URL is live immediately - share it with your team for feedback while you build out your content. -### Install the GitHub App +### Connect GitHub -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 make changes. -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. +From 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** +2. Click **Install GitHub App** (opens GitHub in a new tab) +3. Choose your organization or personal account +4. Select which repositories to connect GitHub App Installation @@ -49,38 +48,39 @@ Install the GitHub App by following the instructions from the onboarding checkli - Update the GitHub App permissions if you move your documentation to a different repository. + Need to connect a different repository later? Update the GitHub App permissions anytime. -### Authorize your GitHub account +### Link your GitHub profile -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. +Connect your personal GitHub account for seamless editing: + +1. Navigate to **Settings** → **My Profile** +2. Click **Authorize GitHub account** - An admin for your GitHub organization may need to authorize your account depending on your organization settings. + Your GitHub organization admin might need to approve this connection first. -## Editing workflows +## Choose your editing style -Mintlify offers two workflows for creating and maintaining your documentation: +Pick the workflow that matches how you like to work: - - For users who prefer working with existing tools in their local environment. Click to jump to this section. + + Edit files in your favorite code editor with full Git workflow support. - - For users who prefer a visual interface in their web browser. Click to jump to this section. + + Visual editing interface - no local setup required. -## 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 directly in your development environment alongside your code. -### Install the CLI +### Get 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 @@ -93,159 +93,164 @@ 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. + Requires Node.js v19 or higher. Having trouble? Check our troubleshooting section below. -### 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 to see the workflow in action: -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: +1. Open your documentation repository +2. Find `index.mdx` and look at the frontmatter: ```mdx index.mdx --- title: "Introduction" -description: "This is the introduction to the documentation" +description: "Welcome to our documentation" --- ``` -3. Update the `title` field to `"Hello World"`. +3. Change the title to something new: ```mdx index.mdx {2} --- -title: "Hello World" -description: "This is the introduction to the documentation" +title: "Welcome to our docs" +description: "Welcome to our documentation" --- ``` -### Preview the changes +### Preview locally -To preview the changes locally, run the following command: +See your changes before publishing: ```bash mint dev ``` -Your preview will be available at `localhost:3000`. +Open `localhost:3000` to see your site running locally. Mintlify Dev Mintlify Dev -### Push the changes +### Deploy your changes -When you are ready to publish your changes, push them to your repository. +When you're happy with your edits, commit and push to GitHub: -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). +```bash +git add . +git commit -m "Update homepage title" +git push +``` -After the deployment completes, your latest update will be available at `.mintlify.app`. +Mintlify detects the changes and automatically rebuilds your site. Track deployment progress in your GitHub Actions or dashboard. - - Optionally, skip the web editor workflow and jump to adding a custom domain. +Your updates go live at `.mintlify.app` within minutes. + + + Ready to use your own domain? Jump ahead to the custom domain section. -## Web editor workflow +## Browser 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 visually without any local setup - perfect for content creators and quick updates. -### Access the web editor +### Open the editor -1. Log in to your [dashboard](https://dashboard.mintlify.com). -2. Select **Editor** on the left sidebar. +1. Log into your [dashboard](https://dashboard.mintlify.com) +2. Click **Editor** in the sidebar - If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor. + First time? You'll be prompted to install the GitHub App if you haven't already. - The Mintlify web editor in the visual editor mode - The Mintlify web editor in the visual editor mode + The Mintlify web editor in visual mode + The Mintlify web editor in visual 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 visually -Find and select `index.mdx` in the file explorer. +Navigate to any file in the sidebar. Let's update your homepage: -Then, in the editor, update the title field to "Hello World". +1. Click `index.mdx` in the file tree +2. Change the title field to "Welcome to our docs" - Editing in Web Editor - Editing in Web Editor + Editing content in the web editor + Editing content in the 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. + Press / anywhere in the editor to open the component menu and add rich content like callouts, code blocks, and more. -### Publish your changes +### Go live 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. Your changes deploy immediately to your live site. - Use branches to preview and review changes through pull requests before deploying to your live site. + Use branches for collaborative editing and review workflows before publishing to production. -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). +Learn more about advanced editor features in our [web editor guide](/editor/getting-started). -## Adding a custom domain +## Custom domain -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. +Replace your `.mintlify.app` URL with your own branded domain for a professional look. -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. - Custom Domain - Custom Domain + Custom Domain Setup + Custom Domain Setup -Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider. +Enter your domain (like `docs.yourcompany.com`) and add this DNS record with your domain 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. + DNS changes typically take 5-30 minutes but can take up to 48 hours in rare cases. -## 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 live! Here's how to make it even better: - - Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. + + Customize colors, fonts, and styling to match your brand perfectly. - - Learn how to customize colors, fonts, and the overall appearance of your documentation site. + + Organize pages with intuitive navigation that helps users find what they need. - - Structure your documentation with intuitive navigation to help users find what they need. + + Make your docs interactive with tabs, accordions, code samples, and more. - - Enhance your documentation with interactive components like accordions, tabs, and code samples. + + Set up analytics, SEO, custom scripts, and other site-wide configurations. - - Create interactive API references with OpenAPI and AsyncAPI specifications. + + Generate interactive API references from your OpenAPI specifications. -## Troubleshooting +## Common issues -If you encounter issues during the setup process, check these common troubleshooting solutions: +Running into problems? Here are quick fixes for the most common issues: - - 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 folder 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. + + Deployments take 2-5 minutes. Check your GitHub Actions tab or dashboard deployment logs for any 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. + + Double-check your CNAME record points to `cname.mintlify.app` and wait for DNS propagation. Use [DNSChecker](https://dnschecker.org) to verify your setup.