Plantillas de Mensajes

Mintlify te da control completo sobre la apariencia y sensación de tu documentación usando el archivo docs.json

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

name · string · required

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

Ejemplo: mintlify

navigation · Navigation[] · required

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

Show Navegación

group · string

El nombre del grupo.

Ejemplo: Configuración

pages · string[]

Las rutas relativas a los archivos markdown que servirán como páginas.

Ejemplo: ["personalizacion", "pagina"]

logo · string or object

Ruta a la imagen del logo u objeto con ruta al 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 el 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 frecuentemente para contenido resaltado, encabezados de sección, acentos, en modo claro

light · string

El color primario para modo oscuro. Usado más frecuentemente 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 de nombres y urls de enlaces que quieres incluir en la barra superior

Show TopbarLink

name · string

El nombre del botón.

Ejemplo: Contáctanos

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

Si es link: A qué enlaza el botón.

Si es github: Enlace al repositorio del que cargar la información de GitHub.

name · string

Texto dentro del botón. Solo requerido si type es link.

versions · string[]

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.

anchors · Anchor[]

Un array de los anclajes, incluye el icon, color, y url.

Show Anclaje

icon · string

El icono de Font Awesome usado para destacar el anclaje.

Ejemplo: comments

name · string

El nombre de la etiqueta del anclaje.

Ejemplo: Comunidad

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 propiedades from y to que son cada una un color hexadecimal.

version · string

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

isDefaultHidden · boolean · default: "false"

Pasa true si quieres ocultar el anclaje hasta que enlaces directamente a alguien a la documentación 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 superior.

Show Objeto

name · string · default: "Documentation"

El nombre del anclaje 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 en Componentes de API.

Show API

baseUrl · string

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.

auth · Auth

Show Auth

method · "bearer" | "basic" | "key"

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

name · string

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]

inputPrefix · string

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.

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 del usuario agregada simple

Aprende más en las guí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, momento en el cual este campo será 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.

Ejemplos:

Absoluta

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

footerSocials · FooterSocials

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"
}

Show FooterSocials

[key] · string

One of the following values website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

Example: x

property · string

The URL to the social platform.

Example: https://x.com/mintlify

feedback · Feedback

Configurations to enable feedback buttons

Show Feedback

suggestEdit · boolean · default: "false"

Enables a button to allow users to suggest edits via pull requests

raiseIssue · boolean · default: "false"

Enables a button to allow users to raise an issue about the documentation

modeToggle · ModeToggle

Customize the dark mode toggle.

Show ModeToggle

default · "light" or "dark"

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.

isHidden · boolean · default: "false"

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

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

backgroundImage · string

A background image to be displayed behind every page. See example with Infisical and FRPC.