docs.json publicado más reciente. Referéncialo en tu archivo con "$schema": "https://mintlify.com/docs.json" para obtener validación y autocompletado en tu editor.
Para obtener contexto sobre lo que hace cada grupo de ajustes, consulta las páginas de temas:
Referencia rápida
Referencia completa de propiedades
$ref
$ref en cualquier nivel de tu docs.json para dividir la configuración en múltiples archivos.
Tipo: string—ruta de archivo relativa a un archivo .json
- Cuando
$refresuelve a un objeto, Mintlify fusiona las claves hermanas del mismo bloque sobre el contenido referenciado, permitiendo que esas claves tengan prioridad sobre las claves coincidentes en la referencia. - Cuando
$refresuelve a un valor que no es un objeto, como un array, Mintlify ignora las claves hermanas. - Los archivos referenciados pueden contener sus propias entradas
$ref, resueltas de forma relativa a ese archivo. - Las rutas deben permanecer dentro de la raíz del proyecto. Las referencias circulares provocan un error de compilación.
Example
$ref para ver más ejemplos.
theme - required
El tema de diseño de tu sitio.
Tipo: string
Opciones: mint, maple, palm, willow, linden, almond, aspen, sequoia, luma
Consulta Temas para ver previsualizaciones.
name - required
El nombre de tu proyecto, organización o producto.
Tipo: string
colors - required
Los colores utilizados en tu documentación.
Tipo: object
colors.primary
required
El color primario. Generalmente se usa para énfasis en el modo claro.
Tipo: string—código hexadecimal que coincide con ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
colors.light
El color usado para énfasis en el modo oscuro.
Tipo: string—código hexadecimal que coincide con ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
colors.dark
El color utilizado para botones y estados hover en ambos modos.
Tipo: string—código hexadecimal que coincide con ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
navigation - required
La estructura de navegación de tu contenido.
Tipo: object
Consulta Navegación para obtener documentación completa.
navigation.global
Elementos de navegación globales que aparecen en todas las páginas y configuraciones regionales.
Tipo: object
navigation.global.tabs
Pestañas de navegación de nivel superior.
Tipo: array of object—cada uno con: tab (string, required), icon (string), iconType (string), hidden (boolean), href (string uri, required)
navigation.global.anchors
Enlaces de ancla en la barra lateral.
Tipo: array of object—cada uno con: anchor (string, required), icon (string), iconType (string), color.light (string hex), color.dark (string hex), hidden (boolean), href (string uri, required)
navigation.global.dropdowns
Menús desplegables.
Tipo: array of object—cada uno con: dropdown (string, required), icon (string), iconType (string), hidden (boolean), href (string uri, required)
navigation.global.languages
Selector de idioma en la navegación global.
Tipo: array of object—cada uno con: language (string, required), default (boolean), hidden (boolean), href (string uri, required)
Códigos de idioma compatibles: ar, ca, cn, cs, da, de, en, es, fr, fr-CA, he, hi, hu, id, it, ja, ja-JP, jp, ko, lv, nl, no, pl, pt, pt-BR, ro, ru, sv, tr, uk, uz, vi, zh, zh-CN, zh-Hans, zh-Hant, zh-TW
navigation.global.versions
Selector de versiones en la navegación global.
Tipo: array of object—cada uno con: version (string, required, longitud mínima 1), default (boolean), hidden (boolean), href (string uri, required)
navigation.global.products
Selector de productos en la navegación global.
Tipo: array of object—cada uno con: product (string, required), description (string), icon (string), iconType (string)
navigation.languages
Selector de idioma para sitios multi-idioma. Cada entrada puede incluir sobrescrituras específicas del idioma para banner, footer y navbar.
Tipo: array of object—cada uno con: language (string, required), default (boolean), hidden (boolean), banner (object), footer (object), navbar (object)
Códigos de idioma compatibles: ar, ca, cn, cs, da, de, en, es, fr, fr-CA, he, hi, hu, id, it, ja, ja-JP, jp, ko, lv, nl, no, pl, pt, pt-BR, ro, ru, sv, tr, uk, uz, vi, zh, zh-CN, zh-Hans, zh-Hant, zh-TW
navigation.versions
Selector de versiones para sitios con múltiples versiones.
Tipo: array of object—cada uno con: default (boolean), tag (string)
navigation.tabs
Pestañas de navegación de nivel superior.
Tipo: array of object—consulta navigation.global.tabs para la estructura.
navigation.anchors
Enlaces de ancla en la barra lateral.
Tipo: array of object—consulta navigation.global.anchors para la estructura.
navigation.dropdowns
Menús desplegables.
Tipo: array of object—consulta navigation.global.dropdowns para la estructura.
navigation.products
Selector de productos. Cada entrada requiere un campo product y puede contener groups, pages, un arreglo menu (con la misma forma que navigation.tabs[].menu, para menús desplegables de producto de varias columnas), iconos o enlaces externos.
Tipo: array of object—cada uno con: product (string, requerido), description (string), icon (string), iconType (string), href (string uri), groups (array), pages (array), menu (array)
navigation.groups
Grupos para organizar el contenido en secciones etiquetadas.
Tipo: array of object
navigation.groups[].boost
Multiplicador numérico aplicado a la clasificación de la búsqueda integrada para cada página de este grupo. Las páginas heredan el factor de boost del grupo ancestro más cercano que lo establece. Usa valores mayores que 1 para priorizar y valores entre 0 y 1 para despriorizar. Consulta Búsqueda.
Tipo: number
navigation.pages
Páginas individuales en tu documentación.
Tipo: array of string or object
navigation.directory
Diseño de directorio para páginas raíz en grupos de navegación. Se hereda recursivamente. Los descendientes pueden sobreescribirlo. Consulta Listados de directorio.
Tipo: "none" | "accordion" | "card"—predeterminado "none"
description
Descripción del sitio para SEO e indexación con IA.
Tipo: string
logo
Logo del sitio. Proporciona una cadena de ruta o objetos separados para light y dark.
Tipo: string u object
logo.light
required (cuando se usa la forma de objeto)
Ruta al logo para el modo claro. Ejemplo: /logo/light.svg.
Tipo: string
logo.dark
required (cuando se usa la forma de objeto)
Ruta al logo para el modo oscuro. Ejemplo: /logo/dark.svg.
Tipo: string
logo.href
URL a la que redirigir al hacer clic en el logo.
Tipo: string (uri)
favicon
Favicon del sitio. Se redimensiona automáticamente. Proporciona una cadena de ruta o objetos separados para light y dark.
Tipo: string u object
favicon.light
required (cuando se usa la forma de objeto)
Ruta al favicon para el modo claro. Ejemplo: /favicon.png.
Tipo: string
favicon.dark
required (cuando se usa la forma de objeto)
Ruta al favicon para el modo oscuro. Ejemplo: /favicon-dark.png.
Tipo: string
appearance
Configuración del modo claro/oscuro.
Tipo: object
appearance.default
Modo de color predeterminado.
Tipo: "system" | "light" | "dark"
Predeterminado: "system"
appearance.strict
Cuando es true, oculta el selector de modo claro/oscuro.
Tipo: boolean
Predeterminado: false
fonts
Tipografías personalizadas. Compatible con Google Fonts y fuentes autoalojadas.
Tipo: object
fonts.family
required (cuando se usa fonts)
Nombre de la familia tipográfica. Los nombres de familias de Google Fonts se cargan automáticamente.
Tipo: string
fonts.weight
Peso de la fuente. Las fuentes variables admiten valores fraccionarios como 550.
Tipo: number
fonts.source
URL a una fuente alojada o ruta a un archivo de fuente local. No es necesario para Google Fonts.
Tipo: string (uri)
fonts.format
Formato del archivo de fuente. Obligatorio cuando se usa fonts.source.
Tipo: "woff" | "woff2"
fonts.heading
Sobrescribe la configuración de fuente para los encabezados. Acepta los mismos campos family, weight, source y format.
Tipo: object
fonts.body
Sobrescribe la configuración de fuente para el texto del cuerpo. Acepta los mismos campos family, weight, source y format.
Tipo: object
icons
Configuración de la biblioteca de iconos.
Tipo: object
icons.library
required
Biblioteca de iconos que se usará en toda tu documentación. Todos los nombres de iconos en tu documentación deben provenir de la biblioteca seleccionada.
Tipo: "fontawesome" | "lucide" | "tabler"
Predeterminado: "fontawesome"
background
Configuración de imagen de fondo, decoración y color.
Tipo: object
background.decoration
Patrón decorativo de fondo.
Tipo: "gradient" | "grid" | "windows"
background.color
Colores de fondo personalizados.
Tipo: object
background.color.light
Color de fondo para el modo claro.
Tipo: string—código hexadecimal que coincide con ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
background.color.dark
Color de fondo para el modo oscuro.
Tipo: string—código hexadecimal que coincide con ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
background.image
Imagen de fondo. Proporciona una cadena de ruta o objetos separados para light y dark.
Tipo: string u object
background.image.light
required (cuando se usa la forma de objeto)
Ruta de la imagen de fondo para el modo claro.
Tipo: string
background.image.dark
required (cuando se usa la forma de objeto)
Ruta de la imagen de fondo para el modo oscuro.
Tipo: string
styling
Controles de estilo visual.
Tipo: object
styling.eyebrows
Estilo del eyebrow de la página que se muestra en la parte superior de la página.
Tipo: "section" | "breadcrumbs"
Predeterminado: "section"
styling.latex
Si se cargan las hojas de estilo de LaTeX. Por defecto, Mintlify auto-detecta el uso de LaTeX.
Tipo: boolean
styling.codeblocks
Configuración del tema de los bloques de código.
Tipo: "system" | "dark" | string (nombre de tema de Shiki) | object
Predeterminado: "system"
Cuando es un objeto:
styling.codeblocks.theme
Un único nombre de tema de Shiki para ambos modos, o un objeto con nombres de temas de Shiki para light y dark.
Tipo: string u object
styling.codeblocks.languages
Configuración personalizada de lenguajes.
Tipo: object
styling.codeblocks.languages.custom
Rutas a archivos JSON que describen lenguajes personalizados de Shiki en formato de gramática de TextMate.
Tipo: array of string
thumbnails
Personalización de miniaturas para redes sociales.
Tipo: object
thumbnails.appearance
Tema visual para las miniaturas.
Tipo: "light" | "dark"
Predeterminado: Esquema de color del sitio
thumbnails.background
Imagen de fondo para las miniaturas. Puede ser una ruta relativa o URL absoluta.
Tipo: string
thumbnails.fonts
Configuración de tipografía para las miniaturas.
Tipo: object
thumbnails.fonts.family
required (cuando se usa thumbnails.fonts)
Nombre de la familia tipográfica. Solo compatible con Google Fonts.
Tipo: string
navbar
Configuración de la barra de navegación superior.
Tipo: object
navbar.links
Enlaces que se muestran en la barra de navegación.
Tipo: array of object—cada uno con:
navbar.primary
Botón principal de llamada a la acción en la barra de navegación.
Tipo: object
footer
Contenido del pie de página y enlaces sociales.
Tipo: object
footer.socials
Perfiles de redes sociales. Cada clave es el nombre de una plataforma, cada valor es la URL de tu perfil.
Tipo: object
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
footer.links
Columnas de enlaces en el pie de página. Máximo 4 columnas.
Tipo: array of object (máx. 4)—cada uno con: header (string), items (array of { label: string, href: string }, required)
banner
Banner para todo el sitio que se muestra en la parte superior de cada página.
Tipo: object
banner.content
required (cuando se usa banner)
Texto del banner. Admite formato MDX básico, incluidos enlaces, negrita y cursiva. Los componentes personalizados no son compatibles.
Tipo: string
banner.dismissible
Si se muestra un botón para descartar.
Tipo: boolean
Predeterminado: false
banner.type
Estilo visual del fondo del banner. Usa info para anuncios generales, warning para avisos de precaución y critical para incidencias urgentes.
Tipo: "info" | "warning" | "critical"
Predeterminado: "info"
banner.color
Color de fondo personalizado que tiene prioridad sobre type. El texto del banner es blanco, así que elige un fondo que siga siendo legible.
Tipo: object con valores hexadecimales light (string) y dark (string), o una sola cadena hexadecimal aplicada a ambos modos.
interaction
Configuración de interacción de navegación.
Tipo: object
interaction.drilldown
Controla la navegación automática cuando un usuario hace clic en un grupo de navegación. Establécelo en true para navegar a la primera página cuando un usuario hace clic en un grupo, false para solo expandir/contraer el grupo sin navegar.
Tipo: boolean
Predeterminado: Predeterminado del tema
contextual
Menú contextual para acciones de página e integraciones de herramientas de IA.
Tipo: object
contextual.options
required
Acciones disponibles en el menú contextual. El primer elemento es la acción predeterminada.
Tipo: array of "assistant" | "copy" | "view" | "download-pdf" | "download-spec" | "chatgpt" | "claude" | "perplexity" | "grok" | "aistudio" | "devin" | "devin-desktop" | "mcp" | "add-mcp" | "cursor" | "vscode" | "devin-mcp" | object
Campos del objeto de opción personalizada:
contextual.display
Dónde mostrar el menú contextual.
Tipo: "header" | "toc"
Predeterminado: "header"
El menú contextual solo está disponible en los despliegues de vista previa y producción.
redirects
Redirecciones para páginas movidas, renombradas o eliminadas.
Tipo: array of object—cada uno con:
variables
Variables de contenido globales reemplazadas en tiempo de compilación usando la sintaxis {{variableName}}.
Tipo: object—pares clave-valor donde las claves son nombres de variables (alfanuméricos y guiones únicamente) y los valores son cadenas de reemplazo.
La sustitución de variables solo se aplica a páginas MDX y snippets. No se aplica a los archivos de especificación OpenAPI (
.yaml, .yml, .json) ni a otros recursos estáticos.metadata
Configuración global de metadatos de página.
Tipo: object
metadata.timestamp
Muestra una fecha de última modificación en todas las páginas. En despliegues respaldados por GitHub o GitLab, la fecha refleja el último commit de git que modificó el archivo de origen de cada página, y recurre a la marca de tiempo del despliegue más reciente cuando no hay una fecha de commit de git disponible.
Establece el campo lastUpdatedDate en el frontmatter de una página para anular la fecha automática. Consulta Páginas para más detalles.
Tipo: boolean
Predeterminado: false
errors
Configuración de páginas de error.
Tipo: object
errors.404
Configuración para la página de error 404 “Página no encontrada”.
Tipo: object
errors.404.redirect
Si se redirige automáticamente a la página de inicio cuando no se encuentra una página.
Tipo: boolean
Predeterminado: true
errors.404.title
Título personalizado para la página 404.
Tipo: string
errors.404.description
Descripción personalizada para la página 404. Admite formato MDX, incluidos enlaces, negrita, cursiva y componentes personalizados.
Tipo: string
api
Configuración de documentación de API y área de pruebas.
Tipo: object
api.openapi
Archivos de especificación OpenAPI.
Tipo: string | array of string | object con source (string) y directory (string)
api.asyncapi
Archivos de especificación AsyncAPI.
Tipo: string | array of string | object con source (string) y directory (string)
api.playground
Configuración del área de pruebas interactiva.
Tipo: object
api.playground.display
Modo de visualización del área de pruebas.
Tipo: "interactive" | "simple" | "none" | "auth"
Predeterminado: "interactive"
api.playground.proxy
Si se enrutan las solicitudes de API a través de un proxy.
Tipo: boolean
Predeterminado: true
api.playground.credentials
Indica si se deben incluir cookies y encabezados de autenticación en las solicitudes cross-origin cuando proxy es false. No tiene efecto cuando proxy es true.
Tipo: boolean
Predeterminado: false
api.params
Configuración de visualización de parámetros de API.
Tipo: object
api.params.expanded
Si se expanden todos los parámetros de forma predeterminada.
Tipo: "all" | "closed"
Predeterminado: "closed"
api.params.post
Claves de campos de la especificación OpenAPI que se mostrarán como píldoras post junto al nombre de cada parámetro. Para cada clave, Mintlify lee el valor del esquema y lo renderiza como una píldora: las cadenas se renderizan literalmente, true renderiza el nombre de la clave, los números se convierten en cadena y los arreglos renderizan una píldora por elemento. Mintlify omite los valores false, null, las cadenas vacías y los objetos.
Tipo: array of string
api.url
Modo de visualización de la URL base.
Tipo: "full"
Predeterminado: Solo se muestra cuando existen múltiples URLs base.
api.examples
Configuración de ejemplos de código.
Tipo: object
api.examples.languages
Lenguajes para los fragmentos de código generados automáticamente. Consulta lenguajes compatibles.
Tipo: array of string
api.examples.defaults
Si se incluyen parámetros opcionales en los ejemplos.
Tipo: "required" | "all"
Predeterminado: "all"
api.examples.prefill
Si se precargan los campos del área de pruebas con valores de ejemplo de la especificación.
Tipo: boolean
Predeterminado: false
api.examples.autogenerate
Si se generan muestras de código a partir de especificaciones de API.
Tipo: boolean
Predeterminado: true
api.mdx
Configuración para páginas de API creadas a partir de archivos MDX.
Tipo: object
api.mdx.auth
Configuración de autenticación para solicitudes de API basadas en MDX.
Tipo: object
api.mdx.auth.method
Método de autenticación.
Tipo: "bearer" | "basic" | "key" | "cobo"
api.mdx.auth.name
Nombre del parámetro de autenticación.
Tipo: string
api.mdx.server
URL base que se antepone a las rutas relativas en el frontmatter api a nivel de página. No se usa cuando el frontmatter contiene una URL completa.
Tipo: string o array
markdown
Configuración para el Markdown que Mintlify sirve a herramientas y agentes de IA. Consulta Exportación de Markdown.
Tipo: object
markdown.schema
Si se incluye la especificación completa de OpenAPI o AsyncAPI en la exportación en Markdown de las páginas de referencia de API.
Tipo: boolean
Predeterminado: true
markdown.instructions
Instrucciones personalizadas para agentes que se añaden al Markdown generado de cada página, así como a tus archivos llms.txt y llms-full.txt. Proporciona una sola cadena o un arreglo de cadenas, que Mintlify une con saltos de línea. Consulta Instrucciones personalizadas para agentes.
Tipo: string o arreglo de cadenas
seo
Configuración de optimización para motores de búsqueda.
Tipo: object
seo.indexing
Qué páginas deben indexar los motores de búsqueda.
Tipo: "navigable" | "all"
Predeterminado: "navigable"
seo.metatags
Meta tags personalizadas añadidas a cada página. Pares clave-valor.
Tipo: object
seo.organization
Organización utilizada como entidad editora en los datos estructurados (JSON-LD) de cada página. Acepta id, name, legalName, url, logo y sameAs. Consulta SEO y búsqueda.
Tipo: object