The @docmd/plugin-seo plugin generates high-quality metadata for every page. It ensures your documentation is not only discoverable by human readers on search engines but also correctly interpreted by AI models and social media platforms.

Configuration

Configure site-wide SEO defaults in your docmd.config.js. Page-level settings always take precedence over global defaults.

Example

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

export default defineConfig({
  plugins: {
    seo: {
      defaultDescription: 'Comprehensive documentation for the docmd ecosystem.',
      aiBots: false,
      twitter: {
        siteUsername: '@docmd_io',
        cardType: 'summary_large_image'
      }
    }
  }
});

Features

• Smart Fallbacks: Automatically extracts the first 150 characters of prose if no description is provided.
• AI Bot Governance: Easily block or allow AI crawlers to differentiate between indexing and LLM training.
• Canonical Resolution: Automatically generates <link rel="canonical"> tags to prevent duplicate content issues.
• Rich Social Previews: Native support for Open Graph and Twitter Cards for professional link sharing.
• Structured Data: Supports LD+JSON Article Schema for rich search snippets.

Page-Level Overrides

Fine-tune settings for individual pages using frontmatter:

---
title: "Advanced Configuration"
noindex: true # Hide from all search engines
seo:
  keywords: ["docmd", "javascript", "ssg"]
  aiBots: true # Override global block for this page
  ldJson: true # Enable Article Schema
---