Saltar al contenido principal
Usa estos ajustes en tu archivo docs.json para controlar la arquitectura de información y la experiencia de usuario de tu sitio. Modifica la barra de navegación, pie de página, banners, comportamiento de navegación, menús contextuales, redirecciones y variables de contenido globales.

​
Ajustes

Tipo: object La estructura de navegación de tu contenido. Aquí es donde defines la jerarquía completa de páginas de tu sitio usando grupos, pestañas, desplegables, anclas y más. Consulta Navegación para obtener documentación completa sobre cómo construir tu estructura de navegación.
​
navigation.global
object
Elementos de navegación globales que aparecen en todas las páginas y configuraciones regionales.
​
navigation.languages
array of object
Selector de idioma para sitios multi-idioma. Cada entrada puede incluir configuraciones específicas del idioma para banner, footer y navbar, además de la estructura de navegación.
​
navigation.versions
array of object
Selector de versiones para sitios con múltiples versiones.
​
navigation.tabs
array of object
Pestañas de navegación de nivel superior.
​
navigation.anchors
array of object
Anclas de la barra lateral.
​
navigation.dropdowns
array of object
Desplegables para agrupar contenido relacionado.
​
navigation.products
array of object
Selector de productos para sitios con múltiples productos.
​
navigation.groups
array of object
Grupos para organizar el contenido en secciones.
​
navigation.pages
array of string or object
Páginas individuales que conforman tu documentación.
Tipo: object Enlaces y botones que se muestran en la barra de navegación superior.
​
navbar.links
array of object
Enlaces que se mostrarán en la barra de navegación.
​
navbar.primary
object
Botón principal de llamada a la acción en la barra de navegación.
docs.json
"navbar": {
  "links": [
    { "type": "github", "href": "https://github.com/your-org/your-repo" },
    { "label": "Comunidad", "href": "https://example.com/community" }
  ],
  "primary": {
    "type": "button",
    "label": "Comenzar",
    "href": "https://example.com/signup"
  }
}
Tipo: object Contenido del pie de página y enlaces a redes sociales.
​
footer.socials
object
Perfiles de redes sociales que se mostrarán en el pie de página. Cada clave es el nombre de una plataforma y cada valor es la URL de tu perfil.Claves válidas: x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast
"socials": {
  "x": "https://x.com/yourhandle",
  "github": "https://github.com/your-org"
}
​
footer.links
array of object
Columnas de enlaces que se muestran en el pie de página.
docs.json
"footer": {
  "socials": {
    "x": "https://x.com/yourhandle",
    "github": "https://github.com/your-org"
  },
  "links": [
    {
      "header": "Empresa",
      "items": [
        { "label": "Blog", "href": "https://example.com/blog" },
        { "label": "Carreras", "href": "https://example.com/careers" }
      ]
    }
  ]
}
Tipo: object Un banner para todo el sitio que se muestra en la parte superior de cada página.
​
banner.content
string
requerido
El contenido de texto que se muestra en el banner. Admite formato MDX básico, incluidos enlaces, texto en negrita y texto en cursiva. Los componentes personalizados no son compatibles.
"content": "Acabamos de lanzar algo nuevo. [Más información](https://example.com)"
​
banner.dismissible
boolean
Si se debe mostrar un botón para descartar para que los usuarios puedan cerrar el banner. El valor predeterminado es false.
docs.json
"banner": {
  "content": "Acabamos de lanzar algo nuevo. [Más información](https://example.com)",
  "dismissible": true
}

​
interaction

Tipo: object Controla el comportamiento de interacción del usuario para los elementos de navegación.
​
interaction.drilldown
boolean
Controla la navegación automática al seleccionar un grupo de navegación. Establécelo en true para navegar automáticamente a la primera página cuando se expande un grupo. Establécelo en false para solo expandir o contraer el grupo sin navegar. Déjalo sin establecer para usar el comportamiento predeterminado del tema.

​
contextual

Tipo: object El menú contextual brinda a los usuarios acceso rápido a herramientas de IA y acciones de la página. Aparece en el encabezado de la página o en la barra lateral de la tabla de contenidos.
El menú contextual solo está disponible en los despliegues de vista previa y producción.
​
contextual.options
array
requerido
Acciones disponibles en el menú contextual. La primera opción del array aparece como la acción predeterminada.Opciones integradas:
  • "add-mcp" — Agrega tu servidor MCP a la configuración del usuario
  • "aistudio" — Envía la página actual a Google AI Studio
  • "assistant" — Abre el asistente de IA con la página actual como contexto
  • "copy" — Copia la página actual como Markdown en el portapapeles
  • "chatgpt" — Envía la página actual a ChatGPT
  • "claude" — Envía la página actual a Claude
  • "cursor" — Instala tu servidor MCP alojado en Cursor
  • "devin" — Envía la página actual a Devin
  • "grok" — Envía la página actual a Grok
  • "mcp" — Copia la URL de tu servidor MCP en el portapapeles
  • "perplexity" — Envía la página actual a Perplexity
  • "view" — Ver la página actual como Markdown en una nueva pestaña
  • "vscode" — Instala tu servidor MCP alojado en VS Code
  • "windsurf" — Envía la página actual a Windsurf
Define opciones personalizadas como objetos:
​
contextual.display
"header" | "toc"
Dónde mostrar las opciones contextuales. Elige header para mostrarlas en el menú contextual de la parte superior de la página, o toc para mostrarlas en la barra lateral de la tabla de contenidos. El valor predeterminado es header.
docs.json
"contextual": {
  "options": ["copy", "view", "chatgpt", "claude"],
  "display": "header"
}

​
redirects

Tipo: array of object Redirecciones para páginas movidas, renombradas o eliminadas. Úsalas para preservar enlaces cuando reorganizas tu contenido.
​
redirects[].source
string
requerido
La ruta desde la que redirigir. Ejemplo: /old-page
​
redirects[].destination
string
requerido
La ruta a la que redirigir. Ejemplo: /new-page
​
redirects[].permanent
boolean
Si es true, emite una redirección permanente (308). Si es false, emite una redirección temporal (307). El valor predeterminado es true.
docs.json
"redirects": [
  {
    "source": "/old-page",
    "destination": "/new-page"
  },
  {
    "source": "/temp-redirect",
    "destination": "/destination",
    "permanent": false
  }
]

​
errors

Tipo: object Configuración de páginas de error personalizadas.
​
errors.404
object
Configuración para la página de error 404 “Página no encontrada”.
docs.json
"errors": {
  "404": {
    "redirect": false,
    "title": "Página no encontrada",
    "description": "La página que buscas no existe. [Ir al inicio](/)."
  }
}

​
variables

Tipo: object Variables globales para usar en toda tu documentación. Mintlify reemplaza los marcadores de posición {{variableName}} con los valores definidos en tiempo de compilación.
​
variables.[variableName]
string
Un par clave-valor donde la clave es el nombre de la variable y el valor es el texto de reemplazo.
  • Los nombres de variables pueden contener caracteres alfanuméricos, guiones y puntos.
  • Debes definir todas las variables referenciadas en tu contenido o la compilación fallará.
  • Mintlify sanitiza los valores para prevenir ataques XSS.
docs.json
"variables": {
  "version": "2.0.0",
  "api-url": "https://api.example.com"
}
En tu contenido, referencia las variables con dobles llaves: 
La versión actual es {{version}}. Realiza solicitudes a {{api-url}}.

​
metadata

Tipo: object Configuración de metadatos a nivel de página aplicada globalmente.
​
metadata.timestamp
boolean
Habilita una fecha de última modificación en todas las páginas. Cuando está habilitado, las páginas muestran la fecha en que el 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
}