diff --git a/quickstart.mdx b/quickstart.mdx index fc6eb78..aeb47ef 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -5,14 +5,9 @@ icon: "rocket" --- - - + + + ## Getting Started @@ -20,6 +15,14 @@ icon: "rocket" Welcome! Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify. + + + + Warning this is a new version + + + + ### Creating the Repository Mintlify docs are rendered from MDX files and configurations defined in our @@ -28,29 +31,26 @@ your docs with your code, and make source control effortless. - If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify [dashboard](https://dashboard.mintlify.com). To create your docs repo without logging into GitHub, follow these instructions: + 1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later. - 2. [Get in touch](mailto:support@mintlify.com) with our team to deploy your repo. - - ![Starter Template](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/starter-template.png) - + 2. [Get in touch](mailto:support@mintlify.com) with our team to deploy your repo. + + ![Starter Template](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/starter-template.png) + - The next step is to install our GitHub app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository. - - ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) - - + + ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) + - ### Updating the Content @@ -60,24 +60,22 @@ your docs. - 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). + 2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). + 3. Use your favorite IDE to open the repository. + 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`. - - Learn more about this in our [local development guide](/development). + Learn more about this in our [local development guide](/development). - Learn more about how to use the web editor on our [guide](/web-editor). - - Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations: ```json @@ -96,11 +94,9 @@ your docs. ``` A full list of supported configurations can be found at [global settings](/settings/global). - - Add content with simple MDX files. Initiate your pages with this template: ```md @@ -112,21 +108,17 @@ your docs. ``` Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components). - - Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com). - - ![Manual Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) - - + + ![Manual Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) + - You can easily set up your API references using an OpenAPI document. 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL. @@ -144,15 +136,12 @@ your docs. 3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`. For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview). - - Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics). - - We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). + We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). @@ -164,18 +153,16 @@ your docs. ### Publishing - Integrate your docs into your website by hosting them on a custom domain. This is included even in the free plan. - - Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. - - ![Custom Domain](/images/custom-domain.png) - + Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. + + ![Custom Domain](/images/custom-domain.png) + Congrats! You've set up your Mintlify Docs and it's looking amazing! Need support or want to give some feedback? You can join our [community](https://mintlify.com/community) or drop us an email at -[support@mintlify.com](mailto:support@mintlify.com). +[support@mintlify.com](mailto:support@mintlify.com). \ No newline at end of file