Skip to content
Merged
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions optimize/seo.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "SEO"
description: "SEO best practices and meta tag configuration for better search visibility"

Check warning on line 3 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L3

'SEO best practices' should use sentence-style capitalization.

Check warning on line 3 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L3

Spell out 'SEO', if it's unfamiliar to the audience.
---

Mintlify automatically handles many SEO best practices, including:

Check warning on line 6 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L6

Spell out 'SEO', if it's unfamiliar to the audience.

- Meta tag generation
- Sitemap and `robots.txt` file generation
Expand Down Expand Up @@ -36,13 +36,17 @@
```

<Note>
Meta tags with colons must be wrapped in quotes.

Check warning on line 39 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L39

In general, use active voice instead of passive voice ('be wrapped').
</Note>

## Common meta tags reference
Below is a comprehensive list of meta tags you can add to your `docs.json`. These meta tags help improve your site's SEO, social sharing, and browser compatibility.

Check warning on line 43 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L43

Spell out 'SEO', if it's unfamiliar to the audience.

<Note>
The `og:image` adds a background image that Mintlify automatically overlays with your logo, page title, and description when generating social media previews.
</Note>

You can preview how your meta tags will appear on different platforms using [metatags.io](https://metatags.io/).

Check warning on line 49 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L49

Avoid using 'will'.

```json expandable
"seo": {
Expand Down Expand Up @@ -152,11 +156,11 @@

### Custom sitemaps and robots.txt files

To add a custom `sitemap.xml` or `robots.txt` file, create a `sitemap.xml` or `robots.txt` file at the root of your project. Adding a custom file will override the automatically generated file of the same name. If you delete a custom file, the default file will be used again.

Check warning on line 159 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L159

Avoid using 'will'.

Check warning on line 159 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L159

Avoid using 'will'.

Check warning on line 159 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L159

In general, use active voice instead of passive voice ('be used').

## Disabling indexing

If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page:

Check warning on line 163 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L163

In general, use active voice instead of passive voice ('being indexed').

```
---
Expand All @@ -178,14 +182,14 @@

<AccordionGroup>
<Accordion title="Write descriptive titles and descriptions">
- Use clear, descriptive page titles (50-60 characters)

Check warning on line 185 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L185

Use parentheses judiciously.
- Write compelling descriptions (150-160 characters)

Check warning on line 186 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L186

Use parentheses judiciously.
- Include relevant keywords
- Make each page title and description unique
</Accordion>

<Accordion title="Optimize your content structure">
- Use proper heading hierarchy (H1 → H2 → H3)

Check warning on line 192 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L192

Use parentheses judiciously.
- Write for humans first, search engines second
- Include relevant keywords in headings and content
- Keep URLs short, descriptive, and organized hierarchically
Expand All @@ -201,7 +205,7 @@

<Accordion title="Image SEO">
- Use descriptive file names for images
- Always include alt text for accessibility and SEO

Check warning on line 208 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L208

Spell out 'SEO', if it's unfamiliar to the audience.
- Optimize image file sizes for faster loading
- Use relevant images that support your content
</Accordion>
Expand Down