SEO y búsqueda
Configura los ajustes de SEO en docs.json: descripción del sitio, indexación en buscadores, meta tags, marcador de la barra de búsqueda y fechas de las páginas.
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.
"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 tudocs.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.metatagsobjectMeta 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"
}seo.organizationobjectOrganización utilizada como entidad editora en los datos estructurados que se emiten en cada página. Todos los campos son opcionales. Cuando se omiten, Mintlify deriva la organización a partir del nombre de tu sitio, el logo de la documentación y la URL del sitio.
id— URL@idestable que identifica tu organización en todas las páginas, por ejemplohttps://example.com/#organization. Su valor predeterminado es<origen del sitio>/#organization.name— Nombre de la organización. Su valor predeterminado es el nombre del sitio.legalName— Nombre legal registrado.url— URL canónica de la página principal de la organización.logo— URL canónica del logo utilizada en los datos estructurados. Su valor predeterminado es el logo de la documentación.sameAs— Arreglo de URLs de perfiles oficiales, como X, LinkedIn o GitHub.
"organization": {
"id": "https://example.com/#organization",
"legalName": "Example Co. Inc.",
"url": "https://example.com",
"logo": "https://example.com/images/logo.png",
"sameAs": [
"https://x.com/example",
"https://github.com/example"
]
}"seo": {
"indexing": "navigable",
"metatags": {
"og:site_name": "Example Co. Docs"
}
}search
Tipo: object
Configuración de visualización de la barra de búsqueda.
search.promptstringTexto de marcador de posición que se muestra en la barra de búsqueda cuando está vacía.
"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.timestampbooleanMuestra 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.
"metadata": {
"timestamp": true
}Ejemplo
{
"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
}
}