Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

El archivo docs.json te permite convertir una colección de archivos Markdown en un sitio de documentación navegable y personalizado. Este archivo de configuración obligatorio controla el estilo, la navigation, integraciones y más. Piénsalo como el plano de tu documentación. La configuración en docs.json se aplica globalmente a todas las páginas.

​
Configurar tu docs.json

Para empezar, solo necesitas especificar theme, name, colors.primary y navigation. Los demás campos son opcionales y puedes agregarlos a medida que crezcan las necesidades de tu documentación. Para una mejor experiencia de edición, incluye la referencia del esquema en la parte superior de tu archivo docs.json. Esto habilita el autocompletado, la validación y las descripciones emergentes útiles en la mayoría de los editores de código: 
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Tu Documentación",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // Tu estructura de navegación
  }
  // El resto de tu configuración
}

​
Referencia

Esta sección contiene la referencia completa del archivo docs.json.

​
Personalización

​
theme
requerido
El tema de diseño de tu sitio.Una de las siguientes: mint, maple, palm, willow, linden, almond, aspen.Consulta Temas para más información.
​
name
string
requerido
El nombre de tu proyecto, organización o producto.
​
colors
object
requerido
Los colores usados en tu documentación. Los colores se aplican de forma diferente según el tema. Si solo proporcionas un color principal, se usará para todos los elementos de color.
​
description
string
Descripción de tu sitio para SEO e indexación en IA.
Tu logotipo para los modos claro y oscuro.
​
favicon
string or object
Ruta a tu archivo de favicon, incluida la extensión. Se redimensiona automáticamente a los tamaños de favicon apropiados. Puede ser un único archivo o archivos separados para los modos claro y oscuro. Ejemplo: /favicon.png
​
thumbnails
object
Personalización de miniaturas para redes sociales y vistas previas de página.
​
styling
object
Configuraciones de estilo visual.
​
icons
object
Configuración de la biblioteca de íconos.
​
fonts
object
Configuración de fuentes para tu documentación. La fuente predeterminada es Inter.
​
appearance
object
Configuración del conmutador de modo claro/oscuro.
​
background
object
Configuración del color y la decoración del fondo.

​
Estructura

​
navbar
object
Elementos de la barra de navegación hacia enlaces externos.
​
navigation
object
requerido
La estructura de navegación de tu contenido.
​
interaction
object
Configuración de interacción del usuario para los elementos de navegación.
​
footer
object
Contenido del pie de página y enlaces a redes sociales.
​
banner
object
Banner del sitio, mostrado en la parte superior de las páginas.
​
redirects
array of object
Redirecciones para páginas movidas, renombradas o eliminadas.
​
contextual
object
Menú contextual para contenido optimizado con IA e integraciones.

​
Configuración de la API

​
api
object
Configuración de la documentación de la API y del área de pruebas interactiva.
​
seo
object
Configuraciones de indexación de SEO.
​
search
object
Configuración de la visualización de la búsqueda.

​
Integraciones

​
Integraciones
object
Integraciones de terceros.

​
Errores

​
errors
object
Configuración para el manejo de errores.

​
Ejemplos

docs.json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. es una empresa que proporciona contenido de ejemplo y texto de marcador de posición.",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentación",
        "icon": "book",
        "description": "Cómo usar el producto de Example Co.",
        "groups": [
          {
            "group": "Primeros pasos",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "Personalización",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "Facturación",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "Cambios",
        "icon": "history",
        "description": "Actualizaciones y cambios",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "Comunidad",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Comenzar",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "Recursos",
        "items": [
          {
            "label": "Clientes",
            "href": "https://example.com/customers"
          },
          {
            "label": "Empresarial",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "Solicitar vista previa",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "Empresa",
        "items": [
          {
            "label": "Empleos",
            "href": "https://example.com/careers"
          },
          {
            "label": "Blog",
            "href": "https://example.com/blog"
          },
          {
            "label": "Política de privacidad",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "No se puede encontrar",
      "description": "¿Qué **pasó** con esta _página_?"
    }
  }
}

​
Actualización desde mint.json

Si tu proyecto de documentación usa el archivo en desuso mint.json, sigue estos pasos para actualizar a docs.json.
1

Instalar o actualizar la CLI

Si aún no has instalado la CLI, instálala ahora:
npm i -g mint
Si ya tienes instalada la CLI, asegúrate de que esté actualizada:
mint update
2

Crear tu archivo docs.json

En tu repositorio de documentación, ejecuta:
mint upgrade
Este comando creará un archivo docs.json a partir de tu mint.json existente. Revisa el archivo generado para asegurarte de que toda la configuración sea correcta.
3

Eliminar tu archivo mint.json

Después de verificar que tu docs.json esté configurado correctamente, puedes eliminar de forma segura tu antiguo archivo mint.json.