Skip to main content
Mintlify 会自动处理众多 SEO 最佳实践,包括:
  • 元标签生成
  • 站点地图与 robots.txt 文件生成
  • 语义化 HTML 结构
  • 移动端优化
你可以在 docs.json 或页面的 frontmatter 中添加 metatags 字段,完全自定义站点的元标签。

全局元标签

你可以在 docs.json 中添加 metadata 字段来设置默认的元标签。

页面级元标签

将元标签按如下方式添加到页面元数据中:
在页面元数据中使用时,包含冒号的 Meta 标签必须用引号括起来。

常用 Meta 标签参考

下面是可添加到你的 docs.json 中的 Meta 标签完整清单。这些 Meta 标签有助于提升站点的 SEO、社交分享效果和浏览器兼容性。 你可以使用 metatags.io 预览这些 Meta 标签在不同平台上的呈现效果。
可展开

站点地图与 robots.txt 文件

Mintlify 会自动生成 sitemap.xmlrobots.txt 文件。你可以在文档站点的 URL 末尾追加 /sitemap.xml 来查看站点地图。 默认只包含 docs.json 中的页面。要包含隐藏链接,请在 docs.json 中添加 seo.indexing

自定义站点地图和 robots.txt 文件

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

禁用索引

如果你想让某个页面不被搜索引擎收录,可以在该页面的frontmatter中添加以下内容:
你也可以在 docs.json 中将 metadata.robots 字段设置为 "noindex",以为文档中的所有页面指定 noindex

SEO 最佳实践

  • 使用清晰、具描述性的页面标题(50–60 个字符)
  • 撰写有吸引力的页面摘要(150–160 个字符)
  • 包含相关关键词
  • 确保每个页面的标题和摘要唯一
  • 使用正确的标题层级(H1 → H2 → H3)
  • 先面向读者写作,其次考虑搜索引擎
  • 在标题与正文中包含相关关键词
  • 保持 URL 简短、具描述性,并按层级组织
  • 使用小标题和列表拆分长篇内容
  • 在文档中链接到相关页面
  • 使用具描述性的锚文本,而非“点击此处”
  • 通过互链相关概念构建主题集群
  • 使用自动交叉引用功能
  • 为图片使用具描述性的文件名
  • 始终提供用于无障碍与 SEO 的 alt 文本
  • 优化图片文件大小以提升加载速度
  • 使用与内容相关、能起到支撑作用的图片