Cada sitio de Mintlify necesita un archivo docs.json con la configuración básica. Aprende más sobre las propiedades a continuación.
Propiedades Nombre de tu proyecto. Usado para el título global. Ejemplo: mintlify
Un array de grupos con todas las páginas dentro de ese grupo El nombre del grupo. Ejemplo: Configuración
Las rutas relativas a los archivos markdown que servirán como páginas. Ejemplo: ["personalizacion", "pagina"]
Ruta a la imagen del logo u objeto con ruta al logo en modo “claro” y “oscuro” Ruta al logo en modo claro
Ruta al logo en modo oscuro
A dónde te lleva el clic en el logo
Ruta a la imagen del favicon
Códigos de color hexadecimal para tu tema global El color primario. Usado más frecuentemente para contenido resaltado, encabezados de sección, acentos, en modo claro
El color primario para modo oscuro. Usado más frecuentemente para contenido resaltado, encabezados de sección, acentos, en modo oscuro
El color primario para botones importantes
El color del fondo tanto en modo claro como oscuro El código de color hexadecimal del fondo en modo claro
El código de color hexadecimal del fondo en modo oscuro
Array de nombres y urls de enlaces que quieres incluir en la barra superior El nombre del botón. Ejemplo: Contáctanos
La url cuando haces clic en el botón. Ejemplo: https://mintlify.com/docs
Mostrar Llamada a la Acción de la Barra Superior
type
"link" or "github"
default: "link"
Link muestra un botón. GitHub muestra la información del repositorio en la url proporcionada incluyendo el número de estrellas de GitHub.
Si es link: A qué enlaza el botón. Si es github: Enlace al repositorio del que cargar la información de GitHub.
Texto dentro del botón. Solo requerido si type es link.
Array de nombres de versiones. Solo usa esto si quieres mostrar diferentes versiones
de documentación con un desplegable en la barra de navegación.
Un array de los anclajes, incluye el icon, color, y url. El icono de Font Awesome usado para destacar el anclaje. Ejemplo: comments El nombre de la etiqueta del anclaje. Ejemplo: Comunidad
El inicio de la URL que marca qué páginas van en el anclaje. Generalmente, este es el nombre de la carpeta donde pones tus páginas.
El color hexadecimal del fondo del icono del anclaje. También puede ser un gradiente si pasas un objeto con las propiedades from y to que son cada una un color hexadecimal.
Usado si quieres ocultar un anclaje hasta que se seleccione la versión correcta de la documentación.
Pasa true si quieres ocultar el anclaje hasta que enlaces directamente a alguien a la documentación dentro de él.
Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, o “thin”
Anula las configuraciones predeterminadas para el anclaje superior. name
string
default: "Documentation"
El nombre del anclaje superior
icon
string
default: "book-open"
Icono de Font Awesome.
Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, o “thin”
Un array de pestañas de navegación. El nombre de la etiqueta de la pestaña.
El inicio de la URL que marca qué páginas van en la pestaña. Generalmente, este
es el nombre de la carpeta donde pones tus páginas.
Configuración para ajustes de API. Aprende más sobre las páginas de API en Componentes de API . La url base para todos los endpoints de API. Si baseUrl es un array, habilitará múltiples opciones
de url base que el usuario puede alternar.
method
"bearer" | "basic" | "key"
La estrategia de autenticación usada para todos los endpoints de API.
El nombre del parámetro de autenticación usado en el playground de API. Si el método es basic, el formato debe ser [nombreUsuario]:[nombreContraseña]
El valor predeterminado que está diseñado para ser un prefijo para el campo de entrada de autenticación. Por ejemplo, si un inputPrefix de ClaveAuth heredaría el resultado de entrada predeterminado del campo de autenticación como ClaveAuth.
Configuraciones para el playground de API mode
"show" | "simple" | "hide"
default: "show"
Si el playground se está mostrando, oculto, o solo mostrando el endpoint sin interactividad del usuario agregada simple Aprende más en las guías del playground Habilitar esta bandera asegura que el orden de las claves en las páginas de OpenAPI coincida con el orden de las claves definido en el archivo OpenAPI. Este comportamiento pronto estará habilitado por defecto, momento en el cual este campo será obsoleto.
Una cadena o un array de cadenas de URL(s) o ruta(s) relativa(s) que apuntan a tu
archivo OpenAPI. Ejemplos: "openapi" : "https://ejemplo.com/openapi.json"
An object of social media accounts where the key:property pair represents the social media platform and the account url. Example: { "x" : "https://x.com/mintlify" , "website" : "https://mintlify.com" }
One of the following values website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news Example: x
The URL to the social platform. Example: https://x.com/mintlify
Configurations to enable feedback buttons Enables a button to allow users to suggest edits via pull requests
Enables a button to allow users to raise an issue about the documentation
Customize the dark mode toggle. Set if you always want to show light or dark mode for new users. When not
set, we default to the same mode as the user’s operating system.
Set to true to hide the dark/light mode toggle. You can combine isHidden with default to force your docs to only use light or dark mode. For example: Only Dark Mode
Only Light Mode
"modeToggle" : { "default" : "dark" , "isHidden" : true }
A background image to be displayed behind every page. See example with
Infisical and FRPC . 
