Saltar al contenido principal
Usa estos ajustes en tu archivo docs.json para controlar cómo los motores de búsqueda indexan tu documentación, qué metadatos aparecen en los resultados de búsqueda, cómo se comporta la barra de búsqueda y si las páginas muestran una marca de tiempo de última modificación.

​
Ajustes

​
description

Tipo: string Una descripción de tu sitio de documentación para SEO e indexación con IA. Aparece en los resultados de los motores de búsqueda y las herramientas de IA la usan para entender el propósito de tu sitio.
docs.json
"description": "Documentación para la API y la plataforma de desarrolladores de Example Co."

​
seo

Tipo: object Configuración de indexación y metadatos para motores de búsqueda.
​
seo.indexing
"navigable" | "all"
Especifica qué páginas deben indexar los motores de búsqueda.
  • navigable — Indexa solo las páginas incluidas en la navegación de tu docs.json. Este es el valor predeterminado.
  • all — Indexa todas las páginas de tu proyecto, incluyendo páginas que no están en la navegación.
​
seo.metatags
object
Meta tags personalizadas añadidas a cada página. Proporciona como pares clave-valor donde cada clave es el nombre de una meta tag y el valor es su contenido.Consulta la referencia de meta tags comunes para ver las opciones disponibles.
"metatags": {
  "og:site_name": "Example Co. Docs",
  "twitter:card": "summary_large_image"
}
docs.json
"seo": {
  "indexing": "navigable",
  "metatags": {
    "og:site_name": "Example Co. Docs"
  }
}
Tipo: object Configuración de visualización de la barra de búsqueda.
​
search.prompt
string
Texto de marcador de posición que se muestra en la barra de búsqueda cuando está vacía.
docs.json
"search": {
  "prompt": "Buscar en la documentación..."
}

​
metadata

Tipo: object Configuración de metadatos a nivel de página aplicada globalmente en todas las páginas.
​
metadata.timestamp
boolean
Muestra una fecha de última modificación en todas las páginas. Cuando está habilitado, cada página muestra la fecha en que su contenido fue modificado por última vez. El valor predeterminado es false.Puedes sobrescribir esta configuración en páginas individuales usando el campo de frontmatter timestamp. Consulta Páginas para más detalles.
docs.json
"metadata": {
  "timestamp": true
}

​
Ejemplo

docs.json
{
  "description": "Documentación para la API y la plataforma de desarrolladores de Example Co.",
  "seo": {
    "indexing": "navigable",
    "metatags": {
      "og:site_name": "Example Co. Docs",
      "twitter:card": "summary_large_image"
    }
  },
  "search": {
    "prompt": "Buscar en la documentación..."
  },
  "metadata": {
    "timestamp": true
  }
}