Saltar al contenido principal

​
Archivo vercel.json

El archivo vercel.json define cómo se compila y se implementa tu proyecto. Se encuentra en el directorio raíz y controla varios aspectos de la implementación, incluidos el enrutamiento, las redirecciones, los encabezados y la configuración de compilación. Usamos la opción rewrites para enrutar mediante proxy las solicitudes desde tu dominio principal hacia tu documentación. Los rewrites reasignan las solicitudes entrantes a distintos destinos sin cambiar la URL en el navegador. Cuando alguien visita yoursite.com/docs, Vercel obtendrá internamente el 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 el valor que prefieras, como /docs, /help o /guides. Además, puedes usar subrutas profundamente anidadas, como /product/docs.

​
Estructura del repositorio

Tus archivos de documentación deben organizarse dentro de tu repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté en yoursite.com/docs, deberías crear 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 domain 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 subdomain 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 implementación en Vercel, debes configurarlo correctamente para evitar conflictos con la verificación del domain de Vercel y el aprovisionamiento de certificados SSL. Una configuración incorrecta del proxy puede impedir que Vercel aprovisione certificados SSL de Let’s Encrypt y provocar errores en la verificación del domain. Consulta los proveedores compatibles en la documentación de Vercel.

​
Lista obligatoria de rutas permitidas

Tu proxy externo debe permitir el tráfico a estas rutas específicas sin bloquear, redirigir ni aplicar un caché agresivo:
  • /.well-known/acme-challenge/* - Obligatorio para la verificación del certificado de Let’s Encrypt
  • /.well-known/vercel/* - Obligatorio para la verificación de domain en Vercel
  • /mintlify-assets/_next/static/* - Obligatorio para los recursos estáticos
Estas rutas deben pasar directamente a tu implementación en 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.

​
Prueba de la configuración del proxy

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