Configuraciones Globales

Cada sitio de Mintlify necesita undocs.json archivo con la configuración básica. Aprende más sobre laspropiedades a continuación.

Propiedades

name

string

required

Nombre de tu proyecto. Usado para el título global.Example: mintlify

Un array de grupos con todas las páginas dentro de ese grupo

Show Navegación

group

string

El nombre del grupo.Example: Settings

pages

string[]

Las rutas relativas a los archivos markdown que servirán como páginas.Example: ["customization", "page"]

logo

string or object

Ruta a la imagen del logo u objeto con ruta a las imágenes del logo en modo “claro” y “oscuro”

Show Logo

light

string

Ruta al logo en modo claro

dark

string

Ruta al logo en modo oscuro

href

string

default:"/"

A dónde te lleva al hacer clic en el logo

favicon

string

Ruta a la imagen del favicon

colors

Colors

Códigos de color hexadecimal para tu tema global

Show Colores

primary

string

required

El color primario. Usado más a menudo para contenido resaltado, encabezados de sección, acentos, en modo claro

light

string

El color primario para el modo oscuro. Usado más a menudo para contenido resaltado, encabezados de sección, acentos, en modo oscuro

dark

string

El color primario para botones importantes

background

object

El color del fondo tanto en modo claro como oscuro

Show Objeto

light

string

required

El código de color hexadecimal del fondo en modo claro

dark

string

required

El código de color hexadecimal del fondo en modo oscuro

topbarLinks

TopbarLink[]

Array denames yurls de enlaces que quieres incluir en la barra superior

Show TopbarLink

name

string

El nombre del botón.Example: Contact us

url

string

La url cuando haces clic en el botón. Ejemplo:https://mintlify.com/docs

topbarCtaButton

Call to Action

Show 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.

url

string

Silink: A qué enlaza el botón.Sigithub: Enlace al repositorio para cargar la información de GitHub.

name

string

Texto dentro del botón. Solo requerido sitype es unlink.

versions

string[]

Array de nombres de versiones. Usa esto solo si quieres mostrar diferentes versiones de documentos con un menú desplegable en la barra de navegación.

anchors

Anchor[]

Un array de los anclajes, incluye elicon,color, yurl.

Show Anclaje

icon

string

ElFont Awesome icono usado para destacar el anclaje.Example: comments

name

string

El nombre de la etiqueta del anclaje.Example: Community

url

string

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.

color

string

El color hexadecimal del fondo del icono del anclaje. También puede ser un gradiente si pasas un objeto con las propiedadesfrom yto que son cada uno un color hexadecimal.

version

string

Usado si quieres ocultar un anclaje hasta que se seleccione la versión correcta de los documentos.

isDefaultHidden

boolean

default:"false"

Pasatrue si quieres ocultar el anclaje hasta que enlaces directamente a alguien a los documentos dentro de él.

iconType

string

default:"duotone"

Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, o “thin”

topAnchor

Object

Anula las configuraciones predeterminadas para el anclaje de nivel superior.

Show Objeto

name

string

default:"Documentation"

El nombre del anclaje de nivel superior

icon

string

default:"book-open"

Icono de Font Awesome.

iconType

string

default:"duotone"

Uno de: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, o “thin”

tabs

Tabs[]

Un array de pestañas de navegación.

Show Pestañas

name

string

El nombre de la etiqueta de la pestaña.

url

string

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.

api

API

Configuración para ajustes de API. Aprende más sobre las páginas de API enAPI Components.

Show API

baseUrl

string

La URL base para todos los endpoints de API. SibaseUrl es un array, habilitará múltiples opciones de URL base que el usuario puede alternar.

auth

Auth

Show Auth

method

"bearer" | "basic" | "key"

La estrategia de autenticación utilizada para todos los endpoints de API.

name

string

El nombre del parámetro de autenticación utilizado en el playground de API.Si el método esbasic, el formato debe ser[usernameName]:[passwordName]

inputPrefix

string

El valor predeterminado que está diseñado para ser un prefijo para el campo de entrada de autenticación.Por ejemplo, si uninputPrefix deAuthKey heredaría el resultado de entrada predeterminado del campo de autenticación comoAuthKey.

playground

Playground

Configuraciones para el playground de API

Show Playground

mode

"show" | "simple" | "hide"

default:"show"

Si el playground se está mostrando, oculto, o solo mostrando el endpoint sin interactividad adicional del usuariosimpleAprende más en lasguías del playground

maintainOrder

boolean

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, en cuyo punto este campo quedará obsoleto.

openapi

string | string[]

Una cadena o un array de cadenas de URL(s) o ruta(s) relativa(s) que apuntan a tu archivo OpenAPI.Examples:

"openapi": "https://example.com/openapi.json"

footerSocials

FooterSocials

Un objeto de cuentas de redes sociales donde el par clave:propiedad representa la plataforma de redes sociales y la URL de la cuenta.Example:

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

Show FooterSocials

[key]

string

Uno de los siguientes valoreswebsite,facebook,x,discord,slack,github,linkedin,instagram,hacker-newsExample: x

property

string

La URL a la plataforma social.Example: https://x.com/mintlify

feedback

Feedback

Configuraciones para habilitar botones de retroalimentación

Show Retroalimentación

suggestEdit

boolean

default:"false"

Habilita un botón para permitir a los usuarios sugerir ediciones a través de pull requests

raiseIssue

boolean

default:"false"

Habilita un botón para permitir a los usuarios plantear un problema sobre la documentación

modeToggle

ModeToggle

Personaliza el interruptor de modo oscuro.

Show ModeToggle

default

"light" or "dark"

Establece si siempre quieres mostrar el modo claro u oscuro para nuevos usuarios. Cuando no se establece, por defecto usamos el mismo modo que el sistema operativo del usuario.

isHidden

boolean

default:"false"

Establece en true para ocultar el interruptor de modo claro/oscuro. Puedes combinarisHidden condefault para forzar que tus documentos solo usen el modo claro u oscuro. Por ejemplo:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

backgroundImage

string

Una imagen de fondo para ser mostrada detrás de cada página. Ver ejemplo conInfisical yFRPC.

Comenzar

Esenciales

Propiedades

Comenzar

Esenciales

​Propiedades

Propiedades