Skip to content

docs: fix typos, broken link, and formatting issues #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos, broken link, and formatting issues #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions essentials/images.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
<img height="200" src="/path/image.jpg" />
Expand Down
2 changes: 1 addition & 1 deletion index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Card>

## Make it yours
Expand Down
4 changes: 2 additions & 2 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Accordion>
<Accordion icon="palette" title="Update your site name and colors">
</Accordion>
<Accordion icon="palette" title="Update your site name and colors">
For a first change, let's update the name and colors of your docs site.

1. Open `docs.json` in your editor.
Expand Down