diff --git a/quickstart.mdx b/quickstart.mdx index 076b50534..f0fdb694f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,90 +1,88 @@ --- 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. +**What you'll need**: A [Mintlify account](https://mintlify.com/start) and 10 minutes of your time. -## Getting started +## Create your site -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: +Sign up for Mintlify and complete the onboarding flow. During setup, you'll: + +1. Choose a project name (this becomes your initial URL) +2. Connect your GitHub repository +3. Select your documentation framework + +Your site deploys automatically to: ``` -https://.mintlify.app +https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - - Mintlify Domain - Mintlify Domain + Your live documentation URL + Your live documentation URL -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 while you customize your docs. -### Install the GitHub App +### Connect GitHub -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +The GitHub integration enables automatic deployments when you push 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** +3. Select your organization and repositories +4. Authorize the connection - GitHub App Installation - GitHub App Installation + GitHub App setup + GitHub App setup - - 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 + + You can change repository permissions later if you move your docs to a different repo. + -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. - +Pick the editing experience that fits your team: - - For users who prefer a visual interface in their web browser. Click to jump to this section. - + + + Edit with your favorite code editor and Git workflow + + + Visual editing directly in your browser + + -## 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 using familiar development tools and Git workflows. ### 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 + npm install -g mint + ``` + + ```bash yarn + yarn global add mint ``` ```bash pnpm @@ -92,160 +90,151 @@ 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 18 or higher. Run `node --version` to check your 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 customize your homepage: -1. Open your repository created during onboarding. -2. Open `index.mdx` and locate the top of the file: +1. Clone your repository locally +2. Open `index.mdx` in your editor +3. Update the frontmatter: ```mdx index.mdx --- -title: "Introduction" -description: "This is the introduction to the documentation" +title: "Welcome to our docs" +description: "Everything you need to get started" --- -``` -3. Update the `title` field to `"Hello World"`. +# Getting started -```mdx index.mdx {2} ---- -title: "Hello World" -description: "This is the introduction to the documentation" ---- +This is your new documentation homepage. Start editing to make it your own. ``` -### 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 runs at `http://localhost:3000` with hot reloading enabled. - Mintlify Dev - Mintlify Dev + Local development preview + Local development preview -### 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). +### Deploy changes -After the deployment completes, your latest update will be available at `.mintlify.app`. +Push your changes to trigger automatic deployment: - - Optionally, skip the web editor workflow and jump to adding a custom domain. - +```bash +git add . +git commit -m "Update homepage" +git push origin main +``` -## Web editor workflow +Your changes go live in under 2 minutes. Track deployment status in your dashboard or GitHub Actions. -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. +## Web editor -### Access the web editor +Edit your documentation visually without leaving your browser. -1. Log in to your [dashboard](https://dashboard.mintlify.com). -2. Select **Editor** on the left sidebar. +### Open the editor - - If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor. - +1. Go to your [Mintlify 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 + Visual web editor interface + Visual 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: +### Edit content -Find and select `index.mdx` in the file explorer. +Navigate to any page in the file tree and start editing: -Then, in the editor, update the title field to "Hello World". +- Rich text formatting with the toolbar +- Drag-and-drop components +- Real-time preview +- Collaborative editing - 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 / to open the component menu and add callouts, code blocks, and more. -### 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** to deploy your changes immediately. No Git knowledge required. - - Use branches to preview and review changes through pull requests before deploying to your live site. - +For team workflows, create branches and pull requests directly in the 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/getting-started). +Learn more in our [web editor guide](/editor/getting-started). -## Adding a custom domain +## Add a 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 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. - - - 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. +1. Go to **Settings** → **Custom Domain** in your dashboard +2. Enter your domain (e.g., `docs.company.com`) +3. Add this DNS record with your domain provider: -| Record Type | Name | Value | TTL | -|-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | +| Type | Name | Value | TTL | +|------|------|-------|-----| +| 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. -## 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 amazing: - - 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. - + + + Colors, fonts, logos, and styling + + + Organize pages with groups and tabs + + + Interactive elements and rich content + + + Auto-generated from OpenAPI specs + + -## 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 18+ and run `mint dev` from your project root (where `docs.json` lives). + + + Check your GitHub Actions tab for build errors. Deployments typically take 1-3 minutes. - - 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 points to `cname.mintlify.app`. Use [DNS Checker](https://dnschecker.org) to test propagation. - - 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. + + Join our [Discord community](https://discord.gg/mintlify) or email support@mintlify.com for help.