Configuración global

El archivo docs.json te permite convertir una colección de archivos Markdown en un sitio de documentación navegable y personalizado. Este archivo de configuración obligatorio controla el estilo, la navegación, las integraciones y más. Piénsalo como el plano de tu documentación. La configuración en docs.json se aplica globalmente a todas las páginas.

Configurar tu `docs.json`

Para empezar, solo necesitas especificar theme, name, colors.primary y navigation. Los demás campos son opcionales y puedes añadirlos a medida que crezcan las necesidades de tu documentación. Para obtener la mejor experiencia de edición, incluye la referencia del esquema en la parte superior de tu archivo docs.json. Esto habilita el autocompletado, la validación y sugerencias útiles en la mayoría de los editores de código:

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Tu Documentación",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // Tu estructura de navegación
  }
  // El resto de tu configuración
}

Referencia

Esta sección contiene la referencia completa del archivo docs.json.

Personalización

requerido

El tema de diseño de tu sitio.Uno de los siguientes: mint, maple, palm, willow, linden, almond, aspen.Consulta Temas para más información.

string

requerido

El nombre de tu proyecto, organización o producto.

object

requerido

Los colores utilizados en tu documentación. Los colores se aplican de forma diferente según el tema. Si solo proporcionas un color principal, se usará para todos los elementos de color.

Mostrar Colors

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

requerido

El color principal de tu documentación. Generalmente se usa para énfasis en el modo claro, con algunas variaciones según el tema.Debe ser un código hex que comience con #.

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

El color usado para énfasis en el modo system.Debe ser un código hex que comience con #.

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

El color utilizado para botones y estados hover tanto en modo claro como en modo system, con algunas variaciones según el tema.Debe ser un código hex que comience con #.

string

Descripción de tu sitio para SEO e indexación con IA.

string or object

Configura tu logo para los modos claro y system.

Mostrar Logo

string

requerido

Ruta al archivo de tu logo para el modo claro. Incluye la extensión del archivo. Ejemplo: /logo.png

string

requerido

Ruta al archivo de tu logo para el modo system. Incluye la extensión del archivo. Ejemplo: /logo-dark.png

string (uri)

La URL a la que redirigir al hacer clic en el logo. Si no se proporciona, el logo enlazará a tu página de inicio. Ejemplo: https://mintlify.com

string or object

Ruta a tu archivo de favicon, incluida la extensión. Se redimensiona automáticamente a los tamaños de favicon apropiados. Puede ser un único archivo o archivos separados para los modos claro y system. Ejemplo: /favicon.png

Mostrar Favicon

string

requerido

Ruta a tu archivo de favicon para el modo claro. Incluye la extensión del archivo. Ejemplo: /favicon.png

string

requerido

Ruta a tu archivo de favicon para el modo system. Incluye la extensión del archivo. Ejemplo: /favicon-dark.png

object

Personalización de miniaturas para redes sociales y vistas previas de página.

Mostrar Thumbnails

"light" | "dark"

El tema visual de tus miniaturas. Si no se especifica, las miniaturas usan el esquema de color de tu sitio definido por el campo colors.

string

Imagen de fondo para tus miniaturas. Puede ser una ruta relativa o una URL absoluta.

object

Configuración tipográfica para las miniaturas. Solo se admiten nombres de familias de Google Fonts.

Mostrar Fonts

string

requerido

Nombre de la familia tipográfica, como “Open Sans” o “Playfair Display”. Se admiten nombres de familias de Google Fonts.

object

Configuración de estilo visual.

Mostrar Estilo

"section" | "breadcrumbs"

El estilo del eyebrow (encabezado superior) de la página. Elige section para mostrar el nombre de la sección o breadcrumbs para mostrar la ruta de navegación completa. El valor predeterminado es section.

boolean

Controla si se incluyen las hojas de estilo de LaTeX, anulando la detección automática. De forma predeterminada, Mintlify detecta automáticamente el uso de LaTeX en tu contenido y carga las hojas de estilo necesarias.

Establécelo en true para forzar la carga de las hojas de estilo de LaTeX cuando la detección automática no reconozca tus expresiones matemáticas.
Establécelo en false para evitar cargar las hojas de estilo de LaTeX y mejorar el rendimiento si no usas expresiones matemáticas pero tienes contenido que activa una detección de falso positivo.

"system" | "dark" | string | object

Configuración del tema de los bloques de código. El valor predeterminado es "system".Configuración simple:

"system": Se ajusta al modo actual del sitio (claro u oscuro)
"dark": Usa siempre el modo oscuro

Configuración de tema personalizado:

Usa una cadena para especificar un único tema de Shiki para todos los bloques de código
Usa un objeto para especificar temas de Shiki separados para los modos claro y oscuro

string

Un único nombre de tema de Shiki que se usará tanto para los modos claro como oscuro.

"styling": {
  "codeblocks": {
    "theme": "dracula"
  }
}

object

Temas separados para los modos claro y oscuro.

Mostrar theme

string

requerido

Un nombre de tema de Shiki para el modo claro.

string

requerido

Un nombre de tema de Shiki para el modo oscuro.

"styling": {
  "codeblocks": {
    "theme": {
      "light": "github-light",
      "dark": "github-dark"
    }
  }
}

object

Configuración personalizada de lenguajes para los bloques de código.

Mostrar languages

array of string

Rutas a archivos JSON que describen lenguajes personalizados de Shiki. Usa esto para agregar resaltado de sintaxis para lenguajes que no estén incluidos en el conjunto predeterminado de Shiki.El archivo JSON debe seguir el formato de gramática de TextMate utilizado por Shiki.

"styling": {
  "codeblocks": {
    "languages": {
      "custom": ["/languages/my-custom-language.json"]
    }
  }
}

object

Configuración de la biblioteca de iconos.

Mostrar Iconos

"fontawesome" | "lucide"

requerido

Biblioteca de iconos que se usará en toda tu documentación. El valor predeterminado es fontawesome.Solo puedes usar una única biblioteca de iconos para tu proyecto. Todos los nombres de iconos en tu documentación deben provenir de la misma biblioteca.

Puedes especificar una URL de un icono alojado externamente, una ruta a un archivo de icono en tu proyecto o código SVG compatible con JSX para cualquier icono individual, independientemente de la configuración de la biblioteca.

object

Configura fuentes personalizadas para tu documentación. La fuente predeterminada varía según el tema.

Mostrar Fuentes

string

requerido

Familia tipográfica, como “Open Sans”. Se admiten nombres de familia de Google Fonts.

number

Peso de la fuente, como 400 o 700. Las fuentes variables admiten pesos precisos como 550.

string (uri)

Uno de:

URL a una fuente alojada, como https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
Ruta a un archivo de fuente local, como /fonts/Hubot-Sans.woff2.

Google Fonts se carga automáticamente cuando especificas un nombre de family de Google Fonts, por lo que no necesitas una URL de source.

"woff" | "woff2"

Formato del archivo de fuente. Obligatorio cuando se usa el campo source.

object

Sobrescribe la configuración de fuente específicamente para los encabezados.

Mostrar Encabezado

string

requerido

Familia tipográfica, como “Open Sans”, “Playfair Display”. Se admiten nombres de familia de Google Fonts.

number

Peso de la fuente, como 400, 700. Las fuentes variables admiten pesos precisos como 550.

string (uri)

Uno de:

URL a una fuente alojada, como https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
Ruta a un archivo de fuente local, como /fonts/Hubot-Sans.woff2.

Google Fonts se carga automáticamente cuando especificas un nombre de family de Google Fonts, por lo que no necesitas una URL de source.

"woff" | "woff2"

Formato del archivo de fuente. Obligatorio cuando se usa el campo source.

object

Sobrescribe la configuración de fuente específicamente para el texto del cuerpo.

Mostrar Cuerpo

string

requerido

Familia tipográfica, como “Open Sans”, “Playfair Display”. Se admiten nombres de familia de Google Fonts.

number

Peso de la fuente, como 400, 700. Las fuentes variables admiten pesos precisos como 550.

string (uri)

Uno de:

URL a una fuente alojada, como https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
Ruta a un archivo de fuente local, como /fonts/Hubot-Sans.woff2.

Google Fonts se carga automáticamente cuando especificas un nombre de family de Google Fonts, por lo que no necesitas una URL de source.

"woff" | "woff2"

Formato del archivo de fuente. Obligatorio cuando se usa el campo source.

object

Configuración del selector de modo claro/oscuro.

Mostrar Apariencia

"system" | "light" | "dark"

Modo de tema predeterminado. Elige system para ajustarse a la configuración del sistema operativo del usuario, o light o dark para forzar un modo específico. El valor predeterminado es system.

boolean

Si se debe ocultar el selector de modo claro/oscuro. El valor predeterminado es false.

object

Configuración del color y la decoración del fondo.

Mostrar Background

string or object

Imagen de fondo para tu sitio. Puede ser un único archivo o archivos separados para los modos claro y oscuro.

Mostrar Image

string

requerido

Ruta de tu imagen de fondo para el modo claro. Incluye la extensión del archivo. Ejemplo: /background.png.

string

requerido

Ruta de tu imagen de fondo para el modo oscuro. Incluye la extensión del archivo. Ejemplo: /background-dark.png.

"gradient" | "grid" | "windows"

Decoración de fondo para tu tema.

object

Colores de fondo personalizados para los modos claro y oscuro.

Mostrar Color

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Color de fondo para el modo claro.Debe ser un código hexadecimal que comience con #.

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Color de fondo para el modo oscuro.Debe ser un código hexadecimal que comience con #.

Estructura

Elementos de la barra de navegación con enlaces externos.

Mostrar Navbar

array of object

Enlaces que se mostrarán en la barra de navegación.

Mostrar Links

string

requerido

Texto del enlace.

string (uri)

requerido

Destino del enlace. Debe ser una URL externa válida.

string

El icono que se mostrará.Opciones:

Nombre del icono de Font Awesome
Nombre del icono de Lucide
Código SVG (compatible con JSX) envuelto entre llaves
URL a un icono alojado externamente
Ruta a un archivo de icono en tu proyecto

Para iconos SVG personalizados:

Convierte tu SVG usando el convertidor SVGR.
Pega tu código SVG en el campo de entrada de SVG.
Copia el elemento completo <svg>...</svg> del campo de salida JSX.
Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
Ajusta height y width según sea necesario.

string

El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.

object

Botón principal en la barra de navegación.

Mostrar Primary

"button" | "github"

requerido

Estilo del botón. Elige button para un botón estándar con label o github para un enlace a un repositorio de GitHub con icon.

string

requerido

Texto del botón. Solo aplica cuando type es button.

string (uri)

requerido

Destino del botón. Debe ser una URL externa. Si type es github, debe ser la URL de un repositorio de GitHub.

La estructura de navegación de tu contenido.

Mostrar Navegación

object

Elementos de navegación globales que aparecen en todas las páginas y secciones.

Mostrar Global

array of object

Configuración del selector de idioma para sitios localizados.

Mostrar Idiomas

"en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "ja" | "jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "id" | "ar" | "tr"

requerido

Código de idioma en formato ISO 639-1.

boolean

Indica si es el idioma predeterminado.

boolean

Indica si se debe ocultar esta opción de idioma de forma predeterminada.

string (uri)

requerido

Ruta válida o enlace externo a esta versión de tu documentación.

array of object

Configuración del selector de versiones para sitios con varias versiones.

Mostrar Versions

string

requerido

Nombre visible de la versión.Longitud mínima: 1

boolean

Indica si esta es la versión predeterminada.

boolean

Indica si se debe ocultar esta opción de versión de forma predeterminada.

string (uri)

requerido

URL o ruta a esta versión de tu documentación.

array of object

Pestañas de navegación de nivel superior para organizar las secciones principales.

Mostrar Tabs

string

requerido

Nombre visible de la pestaña.Longitud mínima: 1

string

El icono que se mostrará.Opciones:

Nombre del icono de Font Awesome
Nombre del icono de Lucide
Código SVG (compatible con JSX) envuelto entre llaves
URL a un icono alojado externamente
Ruta a un archivo de icono en tu proyecto

Para iconos SVG personalizados:

Convierte tu SVG usando el convertidor SVGR.
Pega tu código SVG en el campo de entrada de SVG.
Copia el elemento completo <svg>...</svg> del campo de salida JSX.
Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
Ajusta height y width según sea necesario.

string

El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.

boolean

Indica si esta pestaña se oculta de forma predeterminada.

string (uri)

requerido

URL o ruta de destino de la pestaña.

array of object

Enlaces anclados que aparecen de forma destacada en la navegación de la barra lateral.

Mostrar Anclas

string

requerido

Nombre visible del ancla.Longitud mínima: 1

string

El icono que se mostrará.Opciones:

Nombre del icono de Font Awesome
Nombre del icono de Lucide
Código SVG (compatible con JSX) envuelto entre llaves
URL a un icono alojado externamente
Ruta a un archivo de icono en tu proyecto

Para iconos SVG personalizados:

Convierte tu SVG usando el convertidor SVGR.
Pega tu código SVG en el campo de entrada de SVG.
Copia el elemento completo <svg>...</svg> del campo de salida JSX.
Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
Ajusta height y width según sea necesario.

string

El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.

object

Colores personalizados para el ancla.

Mostrar Color

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Color del ancla para el modo claro.Debe ser un código hexadecimal que comience con #.

string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$

Color del ancla para el modo oscuro.Debe ser un código hexadecimal que comience con #.

boolean

Si ocultar este ancla de forma predeterminada.

string (uri)

requerido

URL o ruta del destino del ancla.

array of object

Menús desplegables para organizar contenido relacionado.

Mostrar Desplegables

Nombre visible del desplegable.Longitud mínima: 1

string

El icono que se mostrará.Opciones:

Nombre del icono de Font Awesome
Nombre del icono de Lucide
Código SVG (compatible con JSX) envuelto entre llaves
URL a un icono alojado externamente
Ruta a un archivo de icono en tu proyecto

Para iconos SVG personalizados:

Convierte tu SVG usando el convertidor SVGR.
Pega tu código SVG en el campo de entrada de SVG.
Copia el elemento completo <svg>...</svg> del campo de salida JSX.
Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
Ajusta height y width según sea necesario.

string

El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.

boolean

Si ocultar este desplegable de forma predeterminada.

string (uri)

requerido

URL o ruta de destino del desplegable.

array of object

Productos para organizar el contenido en secciones.

Mostrar Productos

string

requerido

Nombre visible del producto.

string

Descripción del producto.

string

El icono que se mostrará.Opciones:

Nombre del icono de Font Awesome
Nombre del icono de Lucide
Código SVG (compatible con JSX) envuelto entre llaves
URL a un icono alojado externamente
Ruta a un archivo de icono en tu proyecto

Para iconos SVG personalizados:

Convierte tu SVG usando el convertidor SVGR.
Pega tu código SVG en el campo de entrada de SVG.
Copia el elemento completo <svg>...</svg> del campo de salida JSX.
Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
Ajusta height y width según sea necesario.

string

El estilo de icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.

array of object

Selector de idioma para sitios multilingües.

array of object

Selector de versión para sitios con varias versions.

array of object

Pestañas de navigation de nivel superior Tabs.

array of object

Anclas de la barra lateral anclas.

array of object

Menús desplegables para agrupar contenido relacionado.

array of object

Selector de producto para sitios con varios productos.

array of object

Groups para organizar el contenido en secciones.

array of string or object

Páginas individuales que componen tu documentación.

object

Configuración de la interacción del usuario para los elementos de navegación.

Mostrar Interacción

boolean

Controla el comportamiento de navegación automática al seleccionar grupos de navegación. Establécelo en true para forzar la navegación a la primera página cuando se expande un grupo de navegación. Establécelo en false para evitar la navegación y solo expandir o contraer el grupo. Déjalo sin establecer para usar el comportamiento predeterminado del tema.

object

Configuración de metadatos para las páginas de documentación.

Mostrar Metadatos

boolean

Habilita la fecha de última modificación en todas las páginas. Cuando está habilitado, todas las páginas mostrarán la fecha en que el contenido se modificó por última vez. El valor predeterminado es false.

object

Contenido del pie de página y enlaces a redes sociales.

Mostrar Pie de página

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. Por ejemplo:

{
  "x": "https://x.com/mintlify"
}

Nombres de propiedades válidos: x, website, facebook, youtube, discord, slack, github, linkedin, instagram, hacker-news, medium, telegram, twitter, x-twitter, earth-americas, bluesky, threads, reddit, podcast

array of object

Enlaces que se mostrarán en el pie de página.

Mostrar Enlaces

string

Título de la columna.Longitud mínima: 1

array of object

requerido

Enlaces que se mostrarán en la columna.

Mostrar Elementos

string

requerido

Texto del enlace.Longitud mínima: 1

string (uri)

requerido

URL de destino del enlace.

object

Banner para todo el sitio que se muestra en la parte superior de las páginas.

Mostrar Banner

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. Por ejemplo:

{
  "content": "🚀 Banner is live! [Learn more](mintlify.com)"
}

boolean

Indica si se debe mostrar el botón para descartar en el lado derecho del banner. El valor predeterminado es false.

array of object

Redirecciones para páginas movidas, renombradas o eliminadas.

Mostrar Redirecciones

string

requerido

Ruta de origen desde la que redirigir. Ejemplo: /old-page

string

requerido

Ruta de destino a la que redirigir. Ejemplo: /new-page

boolean

Indica si se debe usar una redirección permanente (301). El valor predeterminado es true.

object

Menú contextual para contenido e integraciones optimizados con IA.

Mostrar Contextual

requerido

Acciones disponibles en el menú contextual. La primera opción aparece como opción predeterminada.

copy: Copia la página actual como Markdown en el portapapeles.
view: Muestra la página actual como Markdown en una nueva pestaña.
chatgpt: Envía el contenido de la página actual a ChatGPT.
claude: Envía el contenido de la página actual a Claude.
perplexity: Envía el contenido de la página actual a Perplexity.
mcp: Copia la URL de tu servidor MCP en el portapapeles.
cursor: Instala tu servidor MCP alojado en Cursor.
vscode: Instala tu servidor MCP alojado en VSCode.

Define opciones personalizadas del menú contextual como objetos con las siguientes propiedades:

Mostrar Opción personalizada

string

requerido

Título visible para la opción personalizada.

string

requerido

Texto de descripción para la opción personalizada.

string

Icono para la opción personalizada. Admite nombres de la librería de iconos, URLs, rutas o código SVG.

string or object

requerido

Destino del enlace para la opción personalizada. Puede ser una cadena de URL simple o un objeto con parámetros base y query opcional.Valores de marcador de posición:

$page: Contenido de la página actual
$path: Ruta de la página actual
$mcp: URL del servidor MCP

El menú contextual solo está disponible en los despliegues de vista previa y producción.

Configuraciones de la API

object

Configuración de la documentación de la API y del área de pruebas interactiva.

Mostrar api

string or array or object

Archivos de especificación OpenAPI para generar la documentación de la API. Puede ser una única URL/ruta o un array de URLs/rutas.

Mostrar openapi

string

URL o ruta a tu archivo de especificación OpenAPI.Longitud mínima: 1

string

Directorio donde buscar archivos OpenAPI.No incluyas una barra inicial.

"openapi": "openapi.json"

"openapi": [
  "openapi/v1.json",
  "openapi/v2.json",
  "https://api.example.com/openapi.yaml"
]

"openapi": {
  "source": "openapi.json",
  "directory": "api-docs"
}

string or array or object

Archivos de especificación AsyncAPI para generar la documentación de la API. Puede ser una única URL/ruta o un array de URLs/rutas.

Mostrar asyncapi

string

URL o ruta a tu archivo de especificación AsyncAPI.Longitud mínima: 1

string

Directorio donde buscar archivos AsyncAPI.No incluyas una barra inicial.

"asyncapi": "asyncapi.json"

"asyncapi": [
  "asyncapi/events.yaml",
  "asyncapi/webhooks.yaml",
  "https://api.example.com/asyncapi.json"
]

"asyncapi": {
  "source": "asyncapi.json",
  "directory": "websockets"
}

object

Configuración de visualización para los parámetros de la API.

Mostrar Params

"all" | "closed"

Indica si se expanden todos los parámetros de forma predeterminada. El valor predeterminado es closed.

object

Configuración del área de pruebas de la API.

Mostrar Playground

"interactive" | "simple" | "none"

Modo de visualización del área de pruebas de la API. El valor predeterminado es interactive.

boolean

Indica si se envían las solicitudes de la API a través de un servidor proxy. El valor predeterminado es true.

object

Configuración para los ejemplos de API generados automáticamente.

Mostrar Examples

array of string

Lenguajes de ejemplo para los fragmentos de API generados automáticamente. Los lenguajes compatibles incluyen:

bash (se muestra como cURL)
go
java
javascript
node (se muestra como Node.js)
php
powershell
python
ruby
swift

También se admiten alias comunes: curl, golang, js, nodejs, rb, sh.

"required" | "all"

Indica si se muestran los parámetros opcionales en los ejemplos de API. El valor predeterminado es all.

boolean

Indica si se precarga el área de pruebas de la API con datos de ejemplos de esquemas. Cuando está habilitado, el área de pruebas rellena automáticamente los campos de solicitud con valores de ejemplo de tu especificación OpenAPI. El valor predeterminado es false.

object

Configuración para las páginas de API generadas a partir de archivos MDX.

Mostrar Mdx

object

Configuración de autenticación para solicitudes de API basadas en MDX.

Mostrar Auth

"bearer" | "basic" | "key" | "cobo"

Método de autenticación para las solicitudes de la API.

string

Nombre de autenticación para las solicitudes de la API.

string or array

Configuración del servidor para las solicitudes de la API.

SEO y búsqueda

object

Configuraciones de indexación de SEO.

Mostrar SEO

object

Meta tags añadidas a cada página. Debe ser un par key-value válido. Consulta la referencia de meta tags comunes para ver las opciones.

"navigable" | "all"

Especifica qué páginas deben indexar los motores de búsqueda. Elige navigable para indexar solo las páginas que están en la navigation de tu docs.json o elige all para indexar todas las páginas. De forma predeterminada, es navigable.

object

Configuración de la visualización de la búsqueda.

Mostrar Search

string

Texto de marcador de posición para mostrar en la barra de búsqueda.

Integraciones

object

Integraciones de terceros.

Mostrar Integraciones

object

Integración con Amplitude Analytics.

Mostrar Amplitude

string

requerido

Tu clave de API de Amplitude.

object

Integración con Microsoft Clarity.

Mostrar Clarity

string

requerido

Tu ID de proyecto de Microsoft Clarity.

object

Integración de enriquecimiento de datos de Clearbit.

Mostrar Clearbit

string

requerido

Tu clave de API de Clearbit.

object

Integración con Fathom Analytics.

Mostrar Fathom

string

requerido

ID del sitio de Fathom.

object

Integración con el chat de Front.

Mostrar Frontchat

string

requerido

Tu ID del snippet de Front chat.Longitud mínima: 6

object

Integración con Google Analytics 4.

Mostrar Ga4

string matching ^G

requerido

Tu ID de medición de Google Analytics 4.Debe coincidir con el patrón: ^G

object

Integración con Google Tag Manager.

Mostrar Gtm

string matching ^G

requerido

Tu ID de etiqueta de Google Tag Manager.Debe coincidir con el patrón: ^G

object

Integración con Heap Analytics.

Mostrar Heap

string

requerido

El ID de tu aplicación de Heap.

object

Integración con Hightouch.

Mostrar Hightouch

string

requerido

Tu write key de Hightouch.

string

Tu host de la API de Hightouch.

object

Integración con Hotjar.

Mostrar Hotjar

string

requerido

Tu ID de Hotjar.

string

requerido

La versión de tu script de Hotjar.

object

Integración con Intercom.

Mostrar Intercom

string

requerido

El ID de tu aplicación de Intercom.Longitud mínima: 6

object

Integración con LogRocket.

Mostrar Logrocket

string

requerido

Tu ID de la app de LogRocket.

object

Integración con Mixpanel.

Mostrar Mixpanel

string

requerido

El token de tu proyecto en Mixpanel.

object

Integración con Osano.

Mostrar Osano

string

requerido

El origen de tu script de Osano.

object

Integración con Pirsch Analytics.

Mostrar Pirsch

string

requerido

Tu ID de Pirsch.

object

Integración con PostHog.

Mostrar Posthog

string matching ^phc\_

requerido

Tu clave de API de PostHog.Debe coincidir con el patrón: ^phc_

string (uri)

Tu host de la API de PostHog.

object

Integración con Plausible Analytics.

Mostrar Plausible

string

requerido

Tu dominio de Plausible.

string

Tu servidor de Plausible.

object

Integración con Segment.

Mostrar Segment

string

requerido

Tu clave de Segment.

object

Configuración de la telemetría.

Mostrar Telemetría

boolean

Indica si se debe habilitar la telemetría.

Cuando se configura en false, las funcionalidades de comentarios también se desactivan y no se muestran en las páginas de tu documentación.

object

Configuración de cookies.

Mostrar Cookies

string

Clave para las cookies.

string

Valor para las cookies.

Errores

object

Configuración para el manejo de errores.

Mostrar Errores

object

Manejo del error 404 “Page not found” (Página no encontrada).

Mostrar 404

boolean

Indica si se debe redirigir automáticamente a la página de inicio cuando no se encuentra una página. De forma predeterminada es true.

string

Título personalizado para la página de error 404.

string

Descripción personalizada para la página de error 404. Admite formato MDX básico, incluyendo enlaces, texto en negrita y en cursiva. No se admiten componentes personalizados.

Ejemplos

Ejemplo básico
Ejemplo de API interactivo
Ejemplo multilingüe

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. es una empresa que proporciona contenido de ejemplo y texto de marcador de posición.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentación",
        "icon": "book",
        "description": "Cómo usar el producto de Example Co.",
        "groups": [
          {
            "group": "Primeros pasos",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Personalización",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Facturación",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Registro de cambios",
        "icon": "history",
        "description": "Actualizaciones y cambios",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Comunidad",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Comenzar",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Recursos",
        "items": [
          {
            "label": "Clientes",
            "href": "https://example.com/customers"
          },
          {
            "label": "Empresarial",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Solicitar vista previa",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Empresa",
        "items": [
          {
            "label": "Empleos",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Política de privacidad",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "No se puede encontrar",
      "description": "¿Qué **pasó** con esta _página_?"
    }
  }
}

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. es una empresa que proporciona contenido de ejemplo y texto de marcador de posición.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentación",
        "icon": "book",
        "description": "Cómo usar el producto de Example Co.",
        "groups": [
          {
            "group": "Primeros pasos",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Personalización",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Facturación",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Referencia de API",
        "icon": "terminal",
        "description": "Cómo usar la API de Example Co.",
        "groups": [
          {
            "group": "Referencia de API",
            "pages": [
              "api-reference/introduction"
            ]
          },
          {
            "group": "Endpoints",
            "openapi": {
              "source": "openapi.json"
            }
          }
        ]
      },
      {
        "dropdown": "Cambios",
        "icon": "history",
        "description": "Actualizaciones y cambios",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "api": {
    "playground": {
      "display": "interactive"
    },
    "examples": {
      "languages": ["javascript", "curl", "python"]
    }
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Comunidad",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Comenzar",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Recursos",
        "items": [
          {
            "label": "Clientes",
            "href": "https://example.com/customers"
          },
          {
            "label": "Empresarial",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Solicitar Vista Previa",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Empresa",
        "items": [
          {
            "label": "Empleos",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Política de Privacidad",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "No se puede encontrar",
      "description": "¿Qué **pasó** con esta _página_?"
    }
  }
}

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. es una empresa que proporciona contenido de ejemplo y texto de marcador de posición.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "global": {
      "anchors": [
        {
          "anchor": "Documentación",
          "href": "https://mintlify.com/docs"
        },
        {
          "anchor": "Registro de cambios",
          "href": "https://mintlify.com/docs/changelog"
        }
      ]
    },
    "languages": [ 
      {
        "language": "en",
        "dropdowns": [
          {
            "dropdown": "Documentación",
            "icon": "book",
            "description": "Cómo usar el producto de Example Co.",
            "pages": [
              {
                "group": "Primeros pasos",
                "pages": ["index", "quickstart"]
              },
              {
                "group": "Personalización",
                "pages": ["settings", "users", "features"]
              },
              {
                "group": "Facturación",
                "pages": [
                  "billing/overview",
                  "billing/payments",
                  "billing/subscriptions"
                ]
              }
            ]
          },
          {
            "dropdown": "Registro de cambios",
            "icon": "history",
            "description": "Actualizaciones y cambios",
            "pages": ["changelog"]
          }
        ]
      },
      {
        "language": "es",
        "dropdowns": [
          {
            "dropdown": "Documentación",
            "icon": "book",
            "description": "Cómo usar el producto de Example Co.",
            "pages": [
              {
                "group": "Primeros pasos",
                "pages": ["es/index", "es/quickstart"]
              },
              {
                "group": "Personalización",
                "pages": ["es/settings", "es/users", "es/features"]
              },
              {
                "group": "Facturación",
                "pages": [
                  "es/billing/overview",
                  "es/billing/payments",
                  "es/billing/subscriptions"
                ]
              }
            ]
          },
          {
            "dropdown": "Registro de cambios",
            "icon": "history",
            "description": "Actualizaciones y cambios",
            "pages": ["es/changelog"]
          }
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Comunidad",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Empezar",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Recursos",
        "items": [
          {
            "label": "Clientes",
            "href": "https://example.com/customers"
          },
          {
            "label": "Empresarial",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Solicitar vista previa",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Empresa",
        "items": [
          {
            "label": "Empleos",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Política de privacidad",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": ["copy", "view", "chatgpt", "claude"]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "No se puede encontrar",
      "description": "¿Qué **pasó** con esta _página_?"
    }
  }
}

Actualizar desde `mint.json`

Si tu proyecto de documentación usa el archivo en desuso mint.json, sigue estos pasos para actualizar a docs.json.

Instala o actualiza la CLI

Si aún no has instalado la CLI, instálala ahora:

npm i -g mint

yarn global add mint

pnpm add -g mint

Si ya tienes instalada la CLI, asegúrate de que esté actualizada:

mint update

Crea tu archivo docs.json

En tu repositorio de documentación, ejecuta:

mint upgrade

Este comando creará un archivo docs.json a partir de tu mint.json existente. Revisa el archivo generado para asegurarte de que toda la configuración sea correcta.

Elimina tu archivo mint.json

Después de verificar que tu docs.json esté configurado correctamente, puedes eliminar de forma segura tu antiguo archivo mint.json.

Comenzar

Organizar

Personalizar

Crear contenido

Documentar APIs

Implementar

Optimizar

Configurar tu `docs.json`

Referencia

Personalización

Estructura

Configuraciones de la API

SEO y búsqueda

Integraciones

Errores

Ejemplos

Actualizar desde `mint.json`

​Configurar tu docs.json

​Referencia

​Personalización

​Estructura

​Configuraciones de la API

​SEO y búsqueda

​Integraciones

​Errores

​Ejemplos

​Actualizar desde mint.json

Configurar tu `docs.json`

Referencia

Personalización

Estructura

Configuraciones de la API

SEO y búsqueda

Integraciones

Errores

Ejemplos

Actualizar desde `mint.json`