diff --git a/quickstart.mdx b/quickstart.mdx index 981c33ccf..9be063187 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -6,12 +6,14 @@ icon: "rocket" This quickstart guide shows you how to set up and deploy your documentation site in minutes. + + + + After you complete this guide, you will have a live documentation site ready to customize and expand. - -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. - + **Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. ## Getting Started @@ -25,8 +27,17 @@ https://.mintlify.app Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). - Mintlify Domain - Mintlify Domain + Mintlify Domain + + Mintlify Domain This URL becomes available immediately and updates when you make changes to your documentation. Use this URL for testing and sharing with your team during development. @@ -43,8 +54,17 @@ Install the GitHub App by following the instructions from the onboarding checkli 4. Select the organization or user account where you want to install the app. Then select the repositories that you want to connect. - GitHub App Installation - GitHub App Installation + GitHub App Installation + + GitHub App Installation @@ -136,8 +156,17 @@ mint dev Your preview will be available at `localhost:3000`. - Mintlify Dev - Mintlify Dev + Mintlify Dev + + Mintlify Dev ### Push the Changes @@ -148,7 +177,7 @@ Mintlify automatically detects the changes, builds your documentation, and deplo After the deployment is complete, your latest update will be available at `.mintlify.app`. - + Optionally, skip the web editor workflow and jump to adding a custom domain. @@ -166,8 +195,17 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf - The Mintlify web editor in the visual editor mode - The Mintlify web editor in the visual editor mode + The Mintlify web editor in the visual editor mode + + The Mintlify web editor in the visual editor mode ### Edit the Documentation @@ -179,12 +217,23 @@ Find and click on `introduction.mdx` in the file explorer. Then, in the visual editor, update the title field to "Hello World". - Editing in Web Editor - Editing in Web Editor + 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. + 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 @@ -199,19 +248,28 @@ For more details about using the web editor, including advanced features like sl 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, go to `Settings` > `Custom Domain` from the dashboard. +To add a custom domain, go to `Settings` \> `Custom Domain` from the dashboard. - Custom Domain - Custom Domain + Custom Domain + + Custom Domain Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS (Domain Name System) settings with your domain provider. -| Record Type | Name | Value | TTL | -|-------------|------|-------|-----| -| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 | + | Record Type | Name | Value | TTL | + | ----------- | ------------------- | ------------------ | ---- | + | CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
@@ -220,18 +278,21 @@ Enter your domain (for example, `docs.yourcompany.com`) and follow the provided ## Next Steps -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +Congratulations\! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: - + 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. @@ -241,7 +302,7 @@ If you encounter issues during the setup process, check these common troubleshoo - Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file. + 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. @@ -251,5 +312,4 @@ If you encounter issues during the setup process, check these common troubleshoo - Need more help? [Contact our Support Team](https://mintlify.com/docs/support). \ No newline at end of file