Cada sitio Mintlify necesita un archivo docs.json con la configuración principal. Más información sobre las propiedades abajo.
Propiedades
Nombre del proyecto. Se usa como título global.Ejemplo: mintlify
Lista de grupos con las páginas de cada grupo
Nombre del grupo.Ejemplo: Settings
Rutas relativas a los archivos markdown que serán páginas.Ejemplo: ["customization", "page"]
Ruta al logo u objeto con rutas para modo claro y oscuro
Ruta al logo en modo claro
Ruta al logo en modo oscuro
Destino al hacer clic en el logo
Colores hex del tema global
Color primario: contenido destacado, cabeceras de sección, acentos en modo claro
Color primario en modo oscuro: contenido destacado, cabeceras, acentos
Color primario para botones importantes
Color de fondo en modo claro y oscuro
Código hex del fondo en modo claro
Código hex del fondo en modo oscuro
Lista de name y url de enlaces en la barra superior
Texto del botón.Ejemplo: Contact us
URL al hacer clic. Ejemplo: https://mintlify.com/docs
Show Topbar Call to Action
type
"link" or "github"
default:"link"
Con link muestra un botón. Con github muestra información del repositorio y estrellas.
Si es link: destino del botón.Si es github: URL del repositorio para cargar datos de GitHub.
Texto del botón. Solo obligatorio si type es link.
Nombres de versión. Úsalo solo si quieres varias versiones de la documentación con selector en la barra de navegación.
Lista de anclas con icon, color y url.
Etiqueta de la ancla.Ejemplo: Community
Prefijo de URL de las páginas de esta ancla. Suele coincidir con el nombre de la carpeta de páginas.
Color hex del fondo del icono. También puede ser un degradado con from y to en hex.
Si quieres ocultar la ancla hasta que se seleccione la versión correcta de la documentación.
true para ocultar la ancla hasta que alguien enlace directamente a documentación dentro de ella.
Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” o “thin”
Sobrescribe la configuración de la ancla superior.
name
string
default:"Documentation"
Nombre de la ancla superior
icon
string
default:"book-open"
Icono de Font Awesome.
Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid” o “thin”
Pestañas de navegación principales.
Prefijo de URL de las páginas de esta pestaña. Suele coincidir con el nombre de la carpeta.
Configuración de la API. Más información en componentes de API.
URL base de los endpoints. Si baseUrl es un array, el usuario puede alternar entre varias bases.
method
"bearer" | "basic" | "key"
Estrategia de autenticación para todos los endpoints.
Nombre del parámetro de autenticación en el playground.Si el método es basic, el formato debe ser [usuario]:[contraseña]
Prefijo por defecto del campo de autenticación.Ej.: con inputPrefix AuthKey, el valor por defecto del campo será AuthKey.
Opciones del playground de API
mode
"show" | "simple" | "hide"
default:"show"
Si el playground está visible, oculto o en modo simple (solo el endpoint, sin interacción).Más en las guías del playground Activa el orden de claves de las páginas OpenAPI igual al del archivo OpenAPI.Pronto será el comportamiento por defecto y este campo quedará obsoleto.
Cadena o lista de URLs o rutas relativas al archivo OpenAPI.Ejemplos:"openapi": "https://example.com/openapi.json"
Objeto de redes: cada clave es la plataforma y el valor la URL.Ejemplo:{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
Una de: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-newsEjemplo: x
URL del perfil o página.Ejemplo: https://x.com/mintlify
Botones de retroalimentación
Botón para sugerir ediciones mediante pull requests
Botón para abrir un issue sobre la documentación
Personaliza el interruptor claro/oscuro.
Fuerza modo claro u oscuro para usuarios nuevos. Si no se define, se usa la preferencia del sistema.
true para ocultar el interruptor. Combínalo con default para forzar solo claro u oscuro. Por ejemplo:"modeToggle": {
"default": "dark",
"isHidden": true
}
Imagen de fondo detrás de todas las páginas. Ejemplos:
Infisical y FRPC. 
