From 16401742b39bde0358c5cb0338b7e2416e52ef32 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 18 May 2026 18:09:41 +0000 Subject: [PATCH] docs: fix typos, broken link, and formatting issues across MDX files --- development.mdx | 2 +- essentials/images.mdx | 4 ++-- index.mdx | 2 +- quickstart.mdx | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/development.mdx b/development.mdx index 8e25d7b..64307ae 100644 --- a/development.mdx +++ b/development.mdx @@ -52,7 +52,7 @@ Port 3000 is already in use. Trying 3001 instead. Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI: ```bash -npm mint update +npm i -g mint@latest ``` ## Validating links diff --git a/essentials/images.mdx b/essentials/images.mdx index 1144eb2..7d4759f 100644 --- a/essentials/images.mdx +++ b/essentials/images.mdx @@ -13,7 +13,7 @@ icon: 'image' ### Using Markdown -The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code +The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code. ```md ![title](/path/image.jpg) @@ -23,7 +23,7 @@ Note that the image file size must be less than 5MB. Otherwise, we recommend hos ### Using embeds -To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images +To get more customizability with images, you can also use [embeds](#embeds-and-html-elements) to add images. ```html diff --git a/index.mdx b/index.mdx index 4122083..a210a9a 100644 --- a/index.mdx +++ b/index.mdx @@ -14,7 +14,7 @@ Get your documentation site up and running in minutes. href="/quickstart" horizontal > - Follow our three step quickstart guide. + Follow our three-step quickstart guide. ## Make it yours diff --git a/quickstart.mdx b/quickstart.mdx index 0ed099d..4a084be 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -32,8 +32,8 @@ Get your documentation site running locally and make your first customization. Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. - - + + For a first change, let's update the name and colors of your docs site. 1. Open `docs.json` in your editor.