Archivo vercel.json

El archivo vercel.json configura cómo se compila y despliega tu proyecto. Se encuentra en el directorio raíz y controla varios aspectos del despliegue, incluidos el enrutamiento, las redirecciones, los encabezados y la configuración de compilación. Usamos la opción rewrites para enviar (proxy) solicitudes desde tu dominio principal hacia tu documentación. Los rewrites mapean las solicitudes entrantes a destinos distintos sin cambiar la URL en el navegador. Cuando alguien visita yoursite.com/docs, Vercel recupera internamente contenido de your-subdomain.mintlify.dev/docs, pero el usuario seguirá viendo yoursite.com/docs en su navegador. Esto es diferente de las redirecciones, que enviarían a los usuarios a una URL completamente distinta. Puedes personalizar la subruta con cualquier valor que prefieras, como /docs, /help o /guides. Además, puedes usar subrutas profundamente anidadas como /product/docs.

Estructura del repositorio

Debes organizar los archivos de documentación dentro de tu repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si quieres tu documentación en yoursite.com/docs, crea un directorio docs/ con todos tus archivos de documentación.

Configuración

Para alojar tu documentación en una subruta personalizada con Vercel, añade la siguiente configuración a tu archivo vercel.json. Este ejemplo usa /docs, pero puedes reemplazarlo por cualquier subruta:
{
  "rewrites": [
    {
      "source": "/docs",
      "destination": "https://[subdomain].mintlify.dev/docs"
    },
    {
      "source": "/docs/:match*",
      "destination": "https://[subdomain].mintlify.dev/docs/:match*"
    }
  ]
}
  • source: El patrón de ruta en tu dominio que activa la reescritura.
  • destination: El destino al que se debe enviar la solicitud mediante proxy.
  • :match*: Un comodín que captura cualquier segmento de ruta después de tu subruta.
Para obtener más información, consulta Configuring projects with vercel.json: Rewrites en la documentación de Vercel.

Generar redirecciones

Ingresa tu subdominio y subdirectorio personalizado para generar las redirecciones para tu archivo vercel.json.

Uso de proxies externos con Vercel

Si usas un proxy externo (como Cloudflare o AWS CloudFront) delante de tu despliegue en Vercel, debes configurarlo correctamente para evitar conflictos con la verificación de dominio de Vercel y la emisión de certificados SSL. Una configuración incorrecta del proxy puede impedir que Vercel emita certificados SSL de Let’s Encrypt y provocar fallos en la verificación de dominio. Consulta los proveedores compatibles en la documentación de Vercel.

Lista de rutas permitidas obligatoria

Tu proxy externo debe permitir el tráfico a estas rutas específicas sin bloquear, redirigir ni aplicar caché de forma agresiva:
  • /.well-known/acme-challenge/* - Requerido para la verificación de certificados de Let’s Encrypt
  • /.well-known/vercel/* - Requerido para la verificación de dominios de Vercel
  • /mintlify-assets/_next/static/* - Requerido para los recursos estáticos
Estas rutas deben pasar directamente a tu despliegue de Vercel sin modificaciones.

Requisitos para el reenvío de encabezados

Asegúrate de que tu proxy reenvíe correctamente el encabezado HOST. Sin un reenvío adecuado de este encabezado, las solicitudes de verificación fallarán.

Probar la configuración de tu proxy

Para confirmar que tu proxy esté correctamente configurado:
  1. Verifica que https://[yourdomain].com/.well-known/vercel/ devuelva una respuesta.
  2. Asegúrate de que los certificados SSL se estén aprovisionando correctamente en tu panel de Vercel.
  3. Comprueba que la verificación del dominio se complete correctamente.