Skip to content

Commit 2589608

Browse files
committed
Update SEO tags
1 parent 53bbd12 commit 2589608

File tree

2 files changed

+14
-29
lines changed

2 files changed

+14
-29
lines changed

components/tooltips.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: 'Tooltips'
3-
description: 'Show a definition when you hover over text.'
3+
description: 'Show a definition when you hover over text'
44
icon: 'message-square'
55
---
66

7+
Tooltips are a way to show a definition when you hover over text.
8+
79
<Tooltip tip="This is a tooltip!">Hover over me</Tooltip> and see a tooltip in action
810

911
<RequestExample>

settings/seo.mdx

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
11
---
22
title: 'SEO'
3-
description: 'Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in docs.json or change them per page.'
3+
description: 'Extend default meta tags for better SEO'
44
icon: 'search'
55
---
66

7-
<Accordion title="Supported Meta Tags">
8-
9-
- og:site_name
10-
- og:title
11-
- og:description
12-
- og:url
13-
- og:image
14-
- og:locale
15-
- og:logo
16-
- article:publisher
17-
- twitter:title
18-
- twitter:description
19-
- twitter:url
20-
- twitter:image
21-
- twitter:site
22-
- og:image:width
23-
- og:image:height
24-
- robots
25-
26-
</Accordion>
27-
28-
## Default meta tags
7+
The platform automatically generates most meta tags.
8+
9+
However, you can fully customize them by adding the [metadata](/core-concepts/settings#param-metadata) field to your `docs.json` or the page's frontmatter.
10+
11+
## Global meta tags
2912

3013
You can set default meta tags by adding the `metadata` field to your `docs.json`.
3114

@@ -37,7 +20,7 @@ You can set default meta tags by adding the `metadata` field to your `docs.json`
3720
}
3821
```
3922

40-
## Changing meta tags on one page
23+
## Page-specific meta tags
4124

4225
Add your meta tags to the page's metadata like so:
4326

@@ -49,14 +32,12 @@ title: 'Your Example Page Title'
4932
```
5033

5134
<Warning>
52-
53-
Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
54-
35+
Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.
5536
</Warning>
5637

5738
## Sitemaps
5839

59-
Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply add `/sitemap.xml` to the end of your website URL to see your sitemap. We recommend submitting the sitemap to search engines for improved SEO.
40+
Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply navigate to `/sitemap.xml` to see your sitemap.
6041

6142
Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`:
6243

@@ -67,7 +48,9 @@ Only pages included in your `docs.json` are included by default. To include hidd
6748
```
6849

6950
## Disabling indexing
51+
7052
If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](/core-concepts/pages) of your page:
53+
7154
```
7255
---
7356
noindex: true

0 commit comments

Comments
 (0)