SEO y Robots
Sitemap automático, robots.txt, etiquetas meta e imágenes Open Graph para motores de búsqueda y redes sociales.
Boltdocs genera automáticamente metadatos SEO para cada página. Esto incluye sitemap.xml, robots.txt, URLs canónicas, etiquetas Open Graph y Twitter Cards.
Referencia de Configuración SEO
SeoConfig
| Propiedad | Tipo | Predeterminado | Descripción |
|---|---|---|---|
indexing | 'all' | 'public' | 'none' | string | 'all' | Controla la etiqueta <meta name="robots">. 'all' y 'public' emiten index,follow; 'none' emite noindex,nofollow. Cadenas personalizadas se emiten tal cual. |
thumbnails | ThumbnailConfig | — | Configuración de imágenes Open Graph. |
defaultImage | string | — | Imagen OG de respaldo para páginas sin frontmatter. |
ThumbnailConfig
| Propiedad | Tipo | Descripción |
|---|---|---|
background | string | Ruta a la imagen de fondo para tarjetas OG. |
theme | 'light' | 'dark' | Tema para miniaturas auto-generadas. |
Referencia de Configuración Robots
| Propiedad | Tipo | Descripción |
|---|---|---|
rules | RobotRule[] | Arreglo de reglas de rastreo. |
sitemaps | string[] | URLs de archivos sitemap.xml. |
RobotRule
| Propiedad | Tipo | Descripción |
|---|---|---|
userAgent | string | User agent objetivo (por ejemplo '*' para todos). |
allow | string | string[] | Rutas a permitir. |
disallow | string | string[] | Rutas a denegar. |
crawlDelay | number | Retraso entre solicitudes (en segundos). |
Archivos Auto-Generados
sitemap.xml
Generado en tiempo de compilación. Contiene todas las rutas indexadas con:
loc— URL completalastmod— Fecha de última modificación (de git o mtime del archivo)changefreq— Frecuencia de actualización de la páginapriority— Calculada a partir de la posición en la barra lateral
robots.txt generado
Generado desde tu configuración robots. Ejemplo de salida:
User-Agent: *
Allow: /
Disallow: /private/
Sitemap: https://docs.example.com/sitemap.xml
Datos estructurados (JSON-LD)
Los datos estructurados son metadatos para buscadores y crawlers. Son independientes del índice de búsqueda interno de Boltdocs. Usa JSON-LD para describir tu sitio, artículos y breadcrumbs mediante un graph compatible con schema.org.
Datos globales del sitio
Usa los helpers seguros para Node desde boltdocs en boltdocs.config.ts:
import {
createWebSiteStructuredData,
defineConfig,
defineStructuredData,
} from 'boltdocs'
export default defineConfig({
siteUrl: 'https://docs.example.com',
seo: {
structuredData: defineStructuredData(
createWebSiteStructuredData({
name: 'Example Docs',
url: 'https://docs.example.com',
description: 'Documentación del producto',
}),
),
},
})
Datos específicos de una página
Agrega structuredData dentro de seo en el frontmatter MDX:
---
title: Primeros pasos
seo:
structuredData:
'@context': https://schema.org
'@type': TechArticle
headline: Primeros pasos
---
En páginas React externas, renderiza <StructuredData data={...} /> desde boltdocs/client. Los helpers createArticleStructuredData y createBreadcrumbStructuredData cubren los graphs más comunes de artículos y navegación.
Referencia de StructuredData
| API | Propósito |
|---|---|
defineStructuredData(data) | Conserva objetos JSON-LD tipados en archivos de configuración. |
createWebSiteStructuredData(options) | Crea un graph WebSite, con acción de búsqueda opcional. |
createArticleStructuredData(options) | Crea un graph Article con autor, fechas, imagen y descripción. |
createBreadcrumbStructuredData(items) | Crea un graph BreadcrumbList desde URLs con nombre. |
<StructuredData data={...} /> | Emite un script seguro application/ld+json desde una página externa. |
Override de SEO por Página
Sobrescribe los ajustes SEO globales en frontmatter:
---
title: Internal Page
seo:
noindex: true
og:image: /custom-og.png
twitter:card: summary
---
| Propiedad | Tipo | Descripción |
|---|---|---|
noindex | boolean | Agrega etiqueta meta noindex. |
og:image | string | Imagen Open Graph personalizada. |
og:type | string | Tipo de Open Graph (predeterminado: 'website'). |
twitter:card | string | Tipo de tarjeta de Twitter. |
Imágenes Open Graph
Boltdocs auto-genera imágenes OG usando seo.thumbnails.background. Cada página obtiene una imagen generada con:
- Tu imagen de fondo
- Título de la página superpuesto
- Nombre del sitio en la esquina
Imagen OG Manual
Sobrescribe por página:
---
seo:
og:image: /assets/my-custom-og.png
---
O globalmente:
export default defineConfig({
seo: {
defaultImage: '/default-og.png',
},
})
URLs Canónicas
Las URLs canónicas se generan automáticamente para cada página basándose en siteUrl + ruta de la página. Esto ayuda a consolidar problemas de contenido duplicado.
Solución de Problemas
sitemap.xml falta
Asegúrate de que siteUrl esté configurado.
Contenido duplicado
Revisa las URLs canónicas en el código fuente de la página. Usa permalink en frontmatter para establecer URLs consistentes.
Imágenes OG no se muestran
Verifica que seo.thumbnails.background apunte a una imagen válida. Revisa los validadores de tarjetas para redes sociales: