@docmd/plugin-seo 插件负责为每个页面生成高质量元数据。它确保你的文档不仅能被搜索引擎发现，还能被 AI 模型和社交媒体平台正确解读。

全局配置

在 docmd.config.js 中配置全站 SEO 默认值。

import { defineConfig } from '@docmd/core';

export default defineConfig({
  plugins: {
    seo: {
      defaultDescription: 'Comprehensive documentation for the docmd ecosystem.',
      aiBots: false, // Set to false to block common AI crawlers (GPTBot, etc.)
      openGraph: {
        defaultImage: '/assets/og-image.png'
      },
      twitter: {
        siteUsername: '@docmd_io',
        cardType: 'summary_large_image'
      }
    }
  }
});

页面级覆盖

可利用 frontmatter 对单个页面精细调整 SEO 设置。页面级设置始终优先于全局默认值。

---
title: "高级配置"
description: "掌握 docmd 内部引擎的各项设置。"
noindex: true # 屏蔽此页面，不被任何搜索引擎索引
seo:
  keywords: ["docmd", "javascript", "ssg"]
  ogType: "article"
  canonicalUrl: "https://mysite.com/canonical-path"
  aiBots: true # 覆盖全局屏蔽，允许 AI 访问此页面
---

核心功能

1. 智能描述回退

如果 frontmatter 或全局配置中未提供描述，插件将自动提取页面正文的前 150 个字符作为 <meta name="description">，确保每个页面均具备基本元数据以于搜索结果摘要。

2. AI 爬虫权限管理

通过设置 aiBots: false，插件会专门借助 noindex 指令屏蔽主流 AI 爬虫（包括 GPTBot、Claude-Web 和 Google-Extended）。这样可以设定传统搜索引擎索引与 LLM 训练的差异化策略。

3. Canonical URL 解析

插件基于 siteUrl 自动生成 <link rel="canonical"> 标签。它能智能处理目录索引，将 guide/index.html 转化为干凁的 /guide/ canonical URL，防止内容重复。

4. 丰富社交分享预览

内置支持 Open Graph 和 Twitter Cards，确保文档链接在 X（Twitter）、LinkedIn 和 Discord 等平台上分享时呈现专业外观。

结构化数据（LD+JSON）

docmd 可自动生成 Article Schema，帮助搜索引擎展示丰富摘要。

---
title: "如何构建 docmd 插件"
seo:
  ldJson: true
---