Cada sitio de documentación requiere un docs.json archivo.
Este archivo contiene la configuración global y controla todo, desde el estilo y la navegación hasta las integraciones.
Referencia Esta sección contiene la referencia completa para el archivo docs.json.
Personalización Uno de los siguientes: mint, maple, palm, willow, linden, almond.
El tema de diseño del proyecto. Consulta la página de Themes para más información.
El nombre del proyecto, organización o producto
Los colores a utilizar en tu documentación. Como mínimo, debes definir el color primario. Por ejemplo:
{ "colors" : { "primary" : "#ff0000" } } primary
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
required
El color primario del tema
Debe ser un código hexadecimal que comience con #
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color claro del tema. Utilizado para el modo oscuro
Debe ser un código hexadecimal que comience con #
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color oscuro del tema. Utilizado para el modo claro
Debe ser un código hexadecimal que comience con #
Descripción opcional utilizada para SEO e indexación de LLM
El logotipo (tanto para modo claro como oscuro)
Ruta que apunta al archivo de logotipo claro para usar en modo oscuro, incluyendo la extensión del archivo. Ejemplo: /logo.png
Ruta que apunta al archivo de logotipo oscuro para usar en modo claro, incluyendo la extensión del archivo. Ejemplo: /logo-dark.png
La URL a la que redirigir al hacer clic en el logotipo. Si no se proporciona, el logotipo enlazará a la página de inicio. Ejemplo: https://example.com
La ruta a tu archivo de favicon en la carpeta de documentos, incluyendo la extensión del archivo. El archivo se redimensionará automáticamente a los tamaños apropiados de favicon.
Puede ser un solo archivo o un par para modo claro y oscuro. Ejemplo: /favicon.png
Ruta que apunta al archivo de favicon claro para usar en modo oscuro, incluyendo la extensión del archivo. Ejemplo: /favicon.png
Ruta que apunta al archivo de favicon oscuro para usar en modo claro, incluyendo la extensión del archivo. Ejemplo: /favicon-dark.png
Configuraciones de estilo
eyebrows
"section" | "breadcrumbs"
El estilo de las cejas del contenido. Por defecto es section.
El tema del bloque de código. Por defecto es system.
Configuración de la biblioteca de iconos
library
"fontawesome" | "lucide"
required
La biblioteca de iconos a utilizar. Por defecto es fontawesome.
La familia de fuentes, como “Open Sans”, “Playfair Display”
El peso de la fuente, como 400, 700. Se admiten pesos de fuente precisos como 550 para fuentes variables.
El formato de la fuente, puede ser uno de woff, woff2
La familia de fuentes, como “Open Sans”, “Playfair Display”
El peso de la fuente, como 400, 700. Se admiten pesos de fuente precisos como 550 para fuentes variables.
El formato de la fuente, puede ser uno de woff, woff2
La familia de fuentes, como “Open Sans”, “Playfair Display”
El peso de la fuente, como 400, 700. Se admiten pesos de fuente precisos como 550 para fuentes variables.
El formato de la fuente, puede ser uno de woff, woff2
Configuración del interruptor de modo claro / oscuro
default
"system" | "light" | "dark"
El modo claro/oscuro predeterminado. Por defecto es system
Si se debe ocultar el interruptor de modo claro / oscuro. Por defecto es true.
Configuración del color de fondo y decoración
decoration
"gradient" | "grid" | "windows"
La decoración de fondo del tema
Los colores del fondo
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color en formato hexadecimal para usar en modo claro
Debe coincidir con el patrón: ^#([a-fA-F0-9]|[a-fA-F0-9])$
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color en formato hexadecimal para usar en modo oscuro
Debe coincidir con el patrón: ^#([a-fA-F0-9]|[a-fA-F0-9])$
Structure Contenido y configuración de la barra de navegación
Los enlaces en la barra de navegación
Una ruta válida o enlace externo
type
"button" | "github"
required
La etiqueta para el botón primario. Esto solo se aplica cuando type está configurado como button.
Una ruta válida o enlace externo. Si type está configurado como github, esta será la URL al repositorio.
La estructura de navegación del contenido
Agregar enlaces externos que aparecerán en todas las secciones y páginas independientemente del anidamiento de navegación
language
"en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "ja" | "jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "id" | "ar" | "tr"
required
El nombre del idioma en formato ISO 639-1
Si este idioma es el idioma predeterminado
Si la opción actual está oculta por defecto
Una ruta válida o enlace externo
El nombre de la versión
Longitud mínima: 1
Si esta versión es la versión predeterminada
Si la opción actual está oculta por defecto
El nombre de la pestaña
Longitud mínima: 1
El icono que se mostrará en la sección
Si la opción actual está oculta por defecto
El nombre del ancla
Longitud mínima: 1
El icono que se mostrará en la sección
light
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color en formato hexadecimal para usar en modo claro
Debe coincidir con el patrón: ^#([a-fA-F0-9]|[a-fA-F0-9])$
dark
string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
El color en formato hexadecimal para usar en modo oscuro
Debe coincidir con el patrón: ^#([a-fA-F0-9]|[a-fA-F0-9])$
Si la opción actual está oculta por defecto
Una ruta válida o enlace externo
El nombre del menú desplegable
Longitud mínima: 1
El icono que se mostrará en la sección
Si la opción actual está oculta por defecto
pages
array of string or object
Configuraciones del pie de página
Un objeto en el que cada clave es el nombre de una plataforma de redes sociales, 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
Los enlaces que se mostrarán en el pie de página
El título del encabezado de la columna
Longitud mínima: 1
Los enlaces que se mostrarán en la columna
La etiqueta del enlace
Longitud mínima: 1
Configuraciones del banner
El contenido del banner. Puede ser una cadena de texto o una cadena de markdown. Por ejemplo:
{ "content" : "🚀 Banner is live! [Learn more](mintlify.com)" } Si el banner se puede descartar. Por defecto es false.
options
array of "copy" | "view" | "chatgpt" | "claude"
required
Las opciones que se mostrarán en el menú contextual. La primera opción es la opción predeterminada.
copy: Copiar la página actual como markdown al portapapelesview: Ver la página actual como markdown en una nueva pestañachatgpt: Alimentar la página actual a ChatGPTclaude: Alimentar la página actual a Claude El menú contextual solo está disponible en despliegues de vista previa y producción.
Configuraciones de API Configuración de referencia de API y ajustes del playground
openapi
string or array or object
Una cadena o un array de cadenas de urls absolutas o relativas que apuntan al archivo(s) OpenAPI
sin barra inicial en el directorio
asyncapi
string or array or object
Una cadena o un array de cadenas de urls absolutas o relativas que apuntan al archivo(s) AsyncAPI
Configuraciones para el playground de API
display
"interactive" | "simple" | "none"
El modo de visualización del playground de API. Por defecto es interactive.
Si se deben pasar las solicitudes de API a través de un servidor proxy. Por defecto es true.
Configuraciones para los ejemplos de API autogenerados
Lenguajes de ejemplo para los fragmentos de API autogenerados
Si se deben mostrar parámetros opcionales en los ejemplos de api, por defecto es all
Configuraciones para páginas de API generadas a partir de archivos MDX
Configuración de autenticación para la API
method
"bearer" | "basic" | "key" | "cobo"
Método de autenticación para la API
Nombre de autenticación para la API
SEO y Búsqueda Configuraciones de indexación SEO
Etiquetas meta añadidas a cada página. Debe ser un par clave-valor válido. Opciones posibles aquí
Especifica qué páginas deben ser indexadas por los motores de búsqueda. Establecer navigable indexa las páginas que están establecidas en la navegación, all indexa todas las páginas. Por defecto es navigable.
Configuración de visualización de búsqueda
El mensaje que se mostrará en el marcador de posición de la barra de búsqueda
Integraciones Configuraciones para integraciones oficiales
measurementId
string matching ^G
required
Debe coincidir con el patrón: ^G
tagId
string matching ^G
required
Debe coincidir con el patrón: ^G
apiKey
string matching ^phc\_
required
Debe coincidir con el patrón: ^phc_
Errores Si se debe redirigir a la página de inicio, si la página no se encuentra
Validación Se recomienda incluir la siguiente referencia de esquema en la parte superior de tu archivo docs.json para garantizar una validación adecuada durante la edición:
{ "$schema" : "https://mintlify.com/docs.json" , ... } 
