SEO y búsqueda

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.

"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.

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"
}

array

Meta tags con alcance a una carpeta. Úsalo para aplicar distintas etiquetas a un subconjunto de páginas, como documentación versionada o un área específica de producto, sin tener que repetirlas en el frontmatter de cada página.Cada entrada tiene:

path: Ruta de carpeta relativa a la raíz de la documentación, como guides/v2, sin barra inicial ni final. Se aplica a todas las páginas dentro de esa carpeta. Cada ruta solo puede aparecer una vez.
metatags: Meta tags añadidas a cada página bajo path, como pares clave-valor. Los valores deben ser cadenas no vacías.

Precedencia, de menor a mayor: seo.metatags, luego las entradas de seo.paths que coincidan (las rutas más largas prevalecen sobre las más cortas cuando una página está en varias) y, por último, el frontmatter de la página.Las rutas se comparan con las URL de las páginas, por lo que las páginas traducidas en una carpeta de idioma necesitan sus propias entradas. Por ejemplo, guides/v1 no se aplica a es/guides/v1.Mintlify ignora la clave canonical en las entradas de seo.paths. Define una URL canónica para todo el sitio en seo.metatags o una URL canónica por página en el frontmatter.

"paths": [
  {
    "path": "guides/v1",
    "metatags": {
      "robots": "noindex"
    }
  },
  {
    "path": "guides/v2",
    "metatags": {
      "og:image": "https://example.com/og/v2.png"
    }
  }
]

object

Organizació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 @id estable que identifica tu organización en todas las páginas, por ejemplo https://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"
  ]
}

docs.json

"seo": {
  "indexing": "navigable",
  "metatags": {
    "og:site_name": "Example Co. Docs"
  }
}

`search`

Tipo: object Configuración de visualización de la barra de búsqueda.

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.

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
  }
}

Primeros pasos

Crear contenido

Administra tu sitio

Agente

Assistant

Contenido preparado para agentes

Búsqueda y SEO

Documentar APIs

Integraciones

Referencia

Ajustes

`description`

`seo`

`search`

`metadata`

Ejemplo

​Ajustes

​description

​seo

​search

​metadata

​Ejemplo

Ajustes

`description`

`seo`

`search`

`metadata`

Ejemplo