Skip to content
11 changes: 6 additions & 5 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"installation",
"editor",
"ai-native",
"migration"
"migration",
"troubleshooting"
]
},
{
Expand Down Expand Up @@ -259,7 +260,6 @@
"guides/maintenance",
"guides/media",
"guides/navigation",
"guides/seo",
"guides/style-and-tone",
"guides/understand-your-audience"
]
Expand Down Expand Up @@ -569,7 +569,6 @@
"fr/guides/maintenance",
"fr/guides/media",
"fr/guides/navigation",
"fr/guides/seo",
"fr/guides/style-and-tone",
"fr/guides/understand-your-audience"
]
Expand Down Expand Up @@ -879,7 +878,6 @@
"es/guides/maintenance",
"es/guides/media",
"es/guides/navigation",
"es/guides/seo",
"es/guides/style-and-tone",
"es/guides/understand-your-audience"
]
Expand Down Expand Up @@ -1189,7 +1187,6 @@
"zh/guides/maintenance",
"zh/guides/media",
"zh/guides/navigation",
"zh/guides/seo",
"zh/guides/style-and-tone",
"zh/guides/understand-your-audience"
]
Expand Down Expand Up @@ -1742,6 +1739,10 @@
{
"source": "/create/broken-links",
"destination": "/create/redirects"
},
{
"source": "/guides/seo",
"destination": "/optimize/seo"
}
],
"integrations": {
Expand Down
51 changes: 0 additions & 51 deletions es/guides/seo.mdx

This file was deleted.

51 changes: 0 additions & 51 deletions fr/guides/seo.mdx

This file was deleted.

43 changes: 0 additions & 43 deletions guides/seo.mdx

This file was deleted.

22 changes: 21 additions & 1 deletion optimize/seo.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
---
title: "SEO"
description: "Optimize SEO with 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

Spell out 'SEO', if it's unfamiliar to the audience.
keywords: ["meta tags", "sitemap", "robots.txt", "SEO", "search engine optimization"]
keywords: ["meta tags", "sitemap", "robots.txt", "SEO", "search engine optimization", "keyword research"]

Check warning on line 4 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L4

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

<Tip>
This page covers both technical SEO configuration and content optimization strategies.

Check warning on line 8 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L8

Spell out 'SEO', if it's unfamiliar to the audience.
</Tip>

Mintlify automatically handles many SEO best practices, including:

Check warning on line 11 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L11

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

- Meta tag generation
- Sitemap and `robots.txt` file generation
Expand All @@ -25,9 +29,9 @@
}
```

### Set a canonical URL

Check warning on line 32 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L32

'Set a canonical URL' should use sentence-style capitalization.

If you're using a custom domain, set the `canonical` meta tag to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content.

Check warning on line 34 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L34

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

```json
"seo": {
Expand All @@ -41,7 +45,7 @@

To set page-specific meta tags, add them to a page's frontmatter.

The following meta tags are supported at the page level:

Check warning on line 48 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L48

In general, use active voice instead of passive voice ('are supported').
- `title` - Page title
- `description` - Page description appears below the title on the page and in some search engine results
- `keywords` - Comma-separated keywords
Expand All @@ -55,7 +59,7 @@
- `twitter:title` - Twitter card title
- `twitter:description` - Twitter card description
- `twitter:image` - Twitter card image
- `twitter:card` - Twitter card type like "summary" or "summary_large_image"

Check warning on line 62 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L62

Did you really mean 'summary_large_image'?
- `twitter:site` - Twitter site handle
- `twitter:image:width` - Twitter image width
- `twitter:image:height` - Twitter image height
Expand All @@ -73,17 +77,17 @@
```

<Note>
Meta tags with colons must be wrapped in quotes. The `keywords` field must be formatted as a YAML array.

Check warning on line 80 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L80

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

Check warning on line 80 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L80

In general, use active voice instead of passive voice ('be formatted').
</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 84 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L84

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 90 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L90

Avoid using 'will'.

```json expandable
"seo": {
Expand Down Expand Up @@ -193,11 +197,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 200 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L200

Avoid using 'will'.

Check warning on line 200 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L200

Avoid using 'will'.

Check warning on line 200 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L200

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](/organize/pages) of your page:

Check warning on line 204 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L204

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

```
---
Expand All @@ -215,18 +219,18 @@
}
```

## SEO best practices

Check warning on line 222 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L222

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

Check warning on line 222 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L222

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

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

Check warning on line 226 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L226

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

Check warning on line 227 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L227

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 233 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L233

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 @@ -242,8 +246,24 @@

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

Check warning on line 249 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L249

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>
</AccordionGroup>

## Page performance

Use tools like [Google PageSpeed Insights](https://pagespeed.web.dev) to identify areas for technical SEO improvement.

Check warning on line 257 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L257

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

Examples of more advanced optimizations:

- **Optimize media for speed:** Compress images using formats like WebP or AVIF and ensure your pages load quickly (ideally under 3 seconds).

Check warning on line 261 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L261

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

Check warning on line 261 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L261

Use parentheses judiciously.
- **Structured data (schema markup):** Add schema markup (like HowTo, FAQ) to your pages to help search engines better understand and rank your content.

Check warning on line 262 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L262

Use parentheses judiciously.

## Keyword research

To increase organic traffic, invest time into understanding which keywords help users land on your documentation.

- **Keyword research:** Use free tools like [Google Keyword Planner](https://ads.google.com/intl/en_us/home/tools/keyword-planner/) or [Keywords Everywhere](https://keywordseverywhere.com) to identify common phrases or long-tail keywords.
- **Integrate keywords naturally:** Add keywords naturally into headings, subheadings, and throughout the body text. Don't overstuff keywords. Your documentation should be written for your users, not search engines.

Check warning on line 269 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L269

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