Plugin de SEO

El plugin @docmd/plugin-seo genera metadatos semánticos y etiquetas de vista previa social para cada página de su documentación. Garantiza una indexación eficaz por parte de motores de búsqueda, una adecuada presentación en plataformas sociales y el cumplimiento de directivas para rastreadores de IA.

Opciones de configuración

Configure los valores predeterminados de SEO en docmd.config.json. Las opciones definidas en el frontmatter de cada página prevalecen sobre estos valores globales.

Ejemplo de configuración global

{
  "layout": {
    "titleSeparator": "-",
    "titleAppend": true
  },
  "plugins": {
    "seo": {
      "defaultDescription": "Documentación técnica integral sobre la plataforma docmd.",
      "breadcrumbs": true,
      "organization": {
        "name": "docmd",
        "url": "https://docmd.io",
        "logo": "https://docmd.io/assets/images/docmd-logo.png",
        "sameAs": [
          "https://github.com/docmd-io/docmd",
          "https://x.com/docmd_io"
        ]
      },
      "aiBots": false,
      "twitter": {
        "siteUsername": "@docmd_io",
        "cardType": "summary_large_image"
      }
    }
  }
}

Capacidades principales

• Generación automática de robots.txt: Crea un archivo robots.txt en la raíz de salida incluyendo ubicaciones de mapas del sitio y directivas de rastreadores de IA.
• Extractos inteligentes: Extrae automáticamente los primeros 150 caracteres del texto si no se ha definido una descripción manual.
• Control de rastreadores de IA: Establezca aiBots: false para impedir el scraping de entrenamiento de IA sin afectar la indexación de motores de búsqueda habituales.
• Emisión de URL canónica: Inyecta elementos <link rel="canonical"> para prevenir problemas de contenido duplicado. Establezca canonicalUrl: false en el frontmatter para suprimir la etiqueta.
• Tarjetas sociales: Genera etiquetas de Open Graph y Twitter Cards con títulos y separadores unificados.
• Datos estructurados (JSON-LD): Inyecta esquemas BreadcrumbList, Organization y WebSite (Sitelinks SearchAction), con compatibilidad para payloads personalizados ldJson en frontmatter.

Orden de resolución de robots.txt

El plugin determina qué archivo robots.txt utilizar siguiendo este orden:

1. Raíz del sitio compilado (site/robots.txt): Si ya existe, se preserva su contenido intacto.
2. Carpeta de recursos fuente (assets/robots.txt): Si existe en su directorio de recursos, se copia automáticamente a la salida (site/robots.txt).
3. Generación automática: Si no se detecta ningún archivo personalizado, docmd lo genera dinámicamente según la configuración del plugin.

Estructura de archivos recomendada:

mi-documentacion/
├── assets/
│   └── robots.txt  # Redacte sus reglas personalizadas aquí
├── index.md
└── docmd.config.json

Anulaciones a nivel de página

Anule los valores globales de SEO para páginas específicas usando el Frontmatter de página:

---
title: "Arquitectura avanzada de motores"
noindex: true # Oculta la página de motores de búsqueda
seo:
  keywords: ["docmd", "arquitectura", "motor"]
  aiBots: true # Permite rastreadores de IA en esta página
  ldJson: true # Inyecta esquema Article
---