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
18 changes: 9 additions & 9 deletions settings/seo.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "SEO"
description: "SEO best practices and meta tag configuration for better search visibility"

Check warning on line 3 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L3

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

Check warning on line 3 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L3

Spell out 'SEO', if it's unfamiliar to the audience.
icon: "search"
---

Mintlify automatically handles many SEO best practices, including:

Check warning on line 7 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L7

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

- Meta tag generation
- Sitemap and `robots.txt` file generation
Expand All @@ -15,7 +15,7 @@

## Global meta tags

You can set default meta tags by adding the `metadata` field to your `docs.json`.
To set default meta tags for all pages, add the `metatags` field to your `docs.json`.

```json
"seo": {
Expand All @@ -27,23 +27,23 @@

## Page-specific meta tags

Add your meta tags to the page's metadata like so:
To set page-specific meta tags, add them to a page's frontmatter.

```mdx
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
title: "Your example page title"
"og:image": "link to your meta tag image"
---
```

<Warning>
Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
</Warning>
<Note>
Meta tags with colons must be wrapped in quotes.

Check warning on line 40 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L40

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

## Common Meta Tags Reference
## 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 44 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L44

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

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

Check warning on line 46 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L46

Avoid using 'will'.

```json expandable
"seo": {
Expand Down Expand Up @@ -153,11 +153,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 156 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L156

Avoid using 'will'.

Check warning on line 156 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L156

Avoid using 'will'.

Check warning on line 156 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L156

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 160 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L160

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

```
---
Expand All @@ -165,7 +165,7 @@
---
```

You can also specify `noindex` for all pages in your docs by setting the `metadata.robots` field to `"noindex"` in your `docs.json`:
You can also specify `noindex` for all pages in your docs by setting the `metatags.robots` field to `"noindex"` in your `docs.json`:

```json
"seo": {
Expand All @@ -179,14 +179,14 @@

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

Check warning on line 182 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L182

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

Check warning on line 183 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L183

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 189 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L189

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 @@ -202,7 +202,7 @@

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

Check warning on line 205 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/seo.mdx#L205

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
Loading