Optimización SEO

Optimiza tu documentación para motores de búsqueda y vistas previas sociales configurando títulos, descripciones y metadatos en el frontmatter.

Qué hace Jamdesk automáticamente

Optimizar tu contenido

Escribir un frontmatter eficaz

---
title: User Authentication    # Under 60 characters
description: Set up OAuth, JWT, and session-based authentication  # 120-160 characters
---

Títulos de página

• Mantén menos de 60 caracteres para evitar truncamiento en los resultados de búsqueda
• Incluye tu palabra clave principal cerca del inicio
• Haz que cada título sea único en toda tu documentación

Descripciones

• Apunta a 120-160 caracteres
• Resume lo que el lector aprenderá
• Incluye palabras clave relevantes de forma natural

Controlar la indexación

Configuración global del sitio

En tu docs.json, configura el comportamiento predeterminado de los robots:

{
  "seo": {
    "metatags": {
      "robots": "index, follow"
    }
  }
}

Control por página

Sobrescribe la indexación de páginas específicas en el frontmatter:

---
title: Internal Notes
noindex: true
---

Usa noindex para:

• Páginas en borrador o en progreso
• Documentación interna
• Contenido obsoleto que conservas como referencia

URLs canónicas

Si tu documentación es accesible desde varias URLs, define una canónica:

---
title: Getting Started
canonical: https://docs.example.com/getting-started
---

También puedes definir una base canónica global en docs.json. Jamdesk añade la ruta de cada página, de modo que cada página obtiene una URL canónica correcta:

{
  "seo": {
    "metatags": {
      "canonical": "https://docs.acme.com"
    }
  }
}

Vistas previas sociales y Open Graph

Jamdesk genera automáticamente una tarjeta social con marca de 1200×630 píxeles para cada página. Puedes sobrescribir cualquier etiqueta social en el frontmatter. Puedes usar claves planas de nivel superior o un bloque seo: anidado. Ambos funcionan; cuando la misma clave está definida de las dos formas, el valor plano de nivel superior tiene prioridad.

---
title: API Reference
description: REST API endpoints and authentication
"og:title": API Reference — Acme
"og:description": Everything you need to call the Acme API
"og:image": /images/api-social-card.png
"twitter:card": summary_large_image
"twitter:creator": "@acme"
keywords: ["api", "rest", "authentication"]
canonical: https://docs.acme.com/api-reference
---

---
title: API Reference
description: REST API endpoints and authentication
seo:
  "og:title": API Reference — Acme
  "og:image": /images/api-social-card.png
  "twitter:card": summary_large_image
  x-custom-tag: any custom meta value
---

Etiquetas compatibles

Imagen predeterminada global del sitio

Define una imagen social de reserva para todas las páginas en docs.json. Cualquier página que defina su propio og:image la sobrescribirá:

{
  "seo": {
    "metatags": {
      "og:image": "https://docs.acme.com/images/default-card.png"
    }
  }
}

Sitemap y Robots.txt

Cada sitio de Jamdesk genera sitemap.xml y robots.txt automáticamente en cada build.

Dónde encontrarlos

Las URLs dependen de si tu documentación está en un dominio raíz o bajo una subruta /docs:

https://docs.acme.com/sitemap.xml
https://docs.acme.com/robots.txt

Qué se incluye en el sitemap

• Todas las páginas publicadas (excluyendo las que tienen noindex o hidden en el frontmatter)
• Fechas de última modificación del frontmatter cuando están disponibles
• Frecuencia de cambio semanal

Excluir páginas del sitemap

Añade noindex al frontmatter para excluir una página tanto del sitemap como de los motores de búsqueda:

---
title: Internal Notes
noindex: true
---

Las páginas con hidden: true también se excluyen automáticamente.

Datos estructurados JSON-LD

Cada página incluye automáticamente datos estructurados de schema.org como una etiqueta <script type="application/ld+json"> con dos esquemas:

• WebSite: nombre del sitio, URL y descripción (de docs.json).
• BreadcrumbList: ruta de navegación desde Inicio hasta la página actual, derivada de tu configuración de navigation.

No se requiere configuración. Los motores de búsqueda usan esto para resultados enriquecidos como rutas de navegación en los listados de búsqueda.

IndexNow

Después de cada build, Jamdesk envía automáticamente las URLs de páginas modificadas a IndexNow para una indexación más rápida en los motores de búsqueda. Esto notifica a Bing, Yandex y otros motores de búsqueda participantes sobre los cambios en tu contenido sin esperar su próximo ciclo de rastreo.

• Se activa después de cada build exitoso
• Solo envía las páginas que realmente cambiaron
• No bloquea el proceso, por lo que nunca retrasa tu build
• No requiere configuración

Buenas prácticas

Revisa esta lista antes de publicar:

Artículos relacionados