SEO（搜索引擎优化）

Mintlify 会自动处理许多 SEO 最佳实践，包括：

元标签生成
站点地图和 robots.txt 文件生成
语义化 HTML 结构
移动端优化

你可以通过在 docs.json 或页面的 frontmatter 中添加 metatags 字段，完全自定义站点的元标签。

自动生成的元标签

Mintlify 会为每个页面生成以下元标签。你可以在 docs.json 或页面的 frontmatter 中指定它们来自定义并覆盖这些元标签。 基础元数据：

charset: utf-8 - 字符编码
og:type: website - Open Graph 类型
og:site_name - 文档站点名称
twitter:card: summary_large_image - Twitter 卡片类型

页面级元数据：

title - 页面标题，格式为「Page Title - Site Name」
og:title - Open Graph 标题，与页面标题相同
twitter:title - Twitter 标题，与页面标题相同
description - 页面说明
og:description - Open Graph 说明，与页面说明相同
twitter:description - Twitter 说明，与页面说明相同

URL 和 canonical：

canonical - 基于页面 URL 自动生成
og:url - 设置为 canonical URL

SEO 和索引编入：

robots - 根据页面 metadata 生成
noindex - 根据页面 metadata 生成
keywords - 根据页面 metadata 生成

图片：

og:image - Open Graph 图片，og:image:width 设为 1200，og:image:height 设为 630
twitter:image - Twitter 图片，twitter:image:width 设为 1200，twitter:image:height 设为 630

浏览器和应用元数据：

applicationName - 文档站点名称
generator: Mintlify - 标识站点生成器为 Mintlify
apple-mobile-web-app-title - iOS 主屏幕应用名称
msapplication-TileColor - Windows 磁贴颜色
来自你配置中的 favicon 和 icon
Sitemap（站点地图）引用链接

docs.json 中 seo.metatags 配置里的任何元标签也会自动注入到每个页面，例如用于搜索控制台验证的 google-site-verification。

全局元标签

要为所有页面设置默认元标签，请在你的 docs.json 中添加 metatags 字段。

"seo": {
    "metatags": {
        "og:image": "您的默认元标签图片链接"
    }
}

设置规范 URL（canonical URL）

如果你使用自定义 domain，请设置 canonical 元标签，确保搜索引擎索引你首选的 domain。规范 URL 会告知搜索引擎你的文档哪个版本是主版本。当你的文档可通过多个 URL 访问时，这有助于提升 SEO（搜索引擎优化），并避免重复内容问题。

"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}

页面级元标签

要为特定页面设置元标签，可将它们添加到页面的 frontmatter 中。页面级支持以下元标签：

title - 页面标题
description - 页面描述，会显示在页面标题下方以及部分搜索引擎结果中
keywords - 以逗号分隔的关键词
og:title - 用于社交分享的 Open Graph 标题
og:description - Open Graph 描述
og:image - Open Graph 图片 URL
og:url - Open Graph URL
og:type - Open Graph 类型，例如 “article” 或 “website”
og:image:width - Open Graph 图片宽度
og:image:height - Open Graph 图片高度
twitter:title - Twitter 卡片标题
twitter:description - Twitter 卡片描述
twitter:image - Twitter 卡片图片
twitter:card - Twitter 卡片类型，例如 “summary” 或 “summary_large_image”
twitter:site - Twitter 站点账号（handle）
twitter:image:width - Twitter 图片宽度
twitter:image:height - Twitter 图片高度
noindex - 设为 true 以阻止搜索引擎收录
robots - Robots 元标签的取值

---
title: "您的示例页面标题"
description: "页面特定描述"
"og:image": "链接到您的元标签图片"
"og:title": "社交媒体标题"
keywords: ["关键词1", "关键词2"]
---

带有冒号的元标签必须用引号括起来。keywords 字段必须格式化为 YAML 数组。

常用 meta 标签参考

下面是可添加到你的 docs.json 中的 meta 标签完整列表。这些 meta 标签有助于提升站点的 SEO（搜索引擎优化）、社交分享表现和浏览器兼容性。

在生成社交媒体预览时，og:image 会作为背景图使用，Mintlify 会在其上自动叠加你的 logo、页面 title 和 description。

你可以使用 metatags.io 预览这些 meta 标签在不同平台上的呈现效果。

"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "页面描述",
      "keywords": "关键词1, 关键词2, 关键词3",
      "author": "作者姓名",
      "robots": "index, follow",
      "googlebot": "index, follow",
      "google": "notranslate",
      "google-site-verification": "verification_token",
      "generator": "Mintlify",
      "theme-color": "#000000",
      "color-scheme": "light dark",
      "canonical": "https://your-custom-domain-here.com",
      "format-detection": "telephone=no",
      "referrer": "origin",
      "refresh": "30",
      "rating": "general",
      "revisit-after": "7 days",
      "language": "en",
      "copyright": "版权所有 2024",
      "reply-to": "email@example.com",
      "distribution": "global",
      "coverage": "全球",
      "category": "技术",
      "target": "全部",
      "HandheldFriendly": "True",
      "MobileOptimized": "320",
      "apple-mobile-web-app-capable": "yes",
      "apple-mobile-web-app-status-bar-style": "black",
      "apple-mobile-web-app-title": "应用标题",
      "application-name": "应用名称",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Open Graph 标题",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Open Graph 描述",
      "og:site_name": "网站名称",
      "og:locale": "en_US",
      "og:video": "https://example.com/video.mp4",
      "og:audio": "https://example.com/audio.mp3",
      "twitter:card": "summary",
      "twitter:site": "@username",
      "twitter:creator": "@username",
      "twitter:title": "Twitter 标题",
      "twitter:description": "Twitter 描述",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "图片描述",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "应用名称",
      "twitter:app:id:iphone": "12345",
      "twitter:app:url:iphone": "app://",
      "article:published_time": "2024-01-01T00:00:00+00:00",
      "article:modified_time": "2024-01-02T00:00:00+00:00",
      "article:expiration_time": "2024-12-31T00:00:00+00:00",
      "article:author": "作者姓名",
      "article:section": "技术",
      "article:tag": "标签1, 标签2, 标签3",
      "book:author": "作者姓名",
      "book:isbn": "1234567890",
      "book:release_date": "2024-01-01",
      "book:tag": "标签1, 标签2, 标签3",
      "profile:first_name": "John",
      "profile:last_name": "Doe",
      "profile:username": "johndoe",
      "profile:gender": "male",
      "music:duration": "205",
      "music:album": "专辑名称",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "艺术家姓名",
      "music:song": "歌曲名称",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "演员姓名",
      "video:actor:role": "角色名称",
      "video:director": "导演姓名",
      "video:writer": "编剧姓名",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "标签1, 标签2, 标签3",
      "video:series": "系列名称"
  }
}

站点地图与 robots.txt 文件

Mintlify 会自动生成 sitemap.xml 和 robots.txt 文件。你可以在文档站点的 URL 后追加 /sitemap.xml 来查看站点地图。默认情况下，仅包含在 docs.json 中的页面会被纳入。若要包含隐藏链接，请在 docs.json 中添加 seo.indexing：

"seo": {
    "indexing": "all"
}

自定义 sitemap 和 robots.txt 文件

要添加自定义的 sitemap.xml 或 robots.txt 文件，请在项目根目录创建对应的 sitemap.xml 或 robots.txt 文件。添加自定义文件会覆盖同名的自动生成文件。删除自定义文件后，将恢复使用默认文件。

禁用索引编入

如果你想阻止某个页面被搜索引擎收录，可以在该页面的 frontmatter 中加入以下内容：

---
noindex: true
---

你也可以在 docs.json 中将 metatags.robots 字段设置为 "noindex"，从而为文档内的所有页面指定 noindex：

"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

SEO 最佳实践

撰写具有描述性的标题和说明

使用清晰、具有描述性的页面标题（50–60 个字符）
撰写有吸引力的说明（150–160 个字符）
包含相关关键词
确保每个页面的标题和说明都独一无二

优化内容结构

使用正确的标题层级（H1 → H2 → H3）
先为人写，其次为搜索引擎写
在标题和正文中包含相关关键词
保持 URL 简短、清晰，并按层级组织
用小标题和列表拆分长内容

内部链接策略

在文档中链接到相关页面
使用描述性的锚文本，而非“click here”
通过连接相关概念构建主题集群
使用自动交叉引用功能

图片 SEO

为图片使用描述性的文件名
始终提供用于无障碍与 SEO 的 alt 文本
优化图片文件大小以加快加载速度
使用与内容相关、能起到支撑作用的图片

快速开始

整理

自定义

创建内容

API 文档

部署

优化

SEO（搜索引擎优化）

自动生成的元标签

全局元标签

设置规范 URL（canonical URL）

页面级元标签

常用 meta 标签参考

站点地图与 robots.txt 文件

自定义 sitemap 和 robots.txt 文件

禁用索引编入

SEO 最佳实践

​自动生成的元标签

​全局元标签

​设置规范 URL（canonical URL）

​页面级元标签

​常用 meta 标签参考

​站点地图与 robots.txt 文件

​自定义 sitemap 和 robots.txt 文件

​禁用索引编入

​SEO 最佳实践

自动生成的元标签

全局元标签

设置规范 URL（canonical URL）

页面级元标签

常用 meta 标签参考

站点地图与 robots.txt 文件

自定义 sitemap 和 robots.txt 文件

禁用索引编入

SEO 最佳实践