Saltar al contenido principal

​
archivo vercel.json

El archivo vercel.json define cómo se crea y se despliega tu proyecto. Se encuentra en el directorio raíz y controla varios aspectos del despliegue, incluidos el ruteo, las redirecciones, los encabezados y la configuración de compilación. Usamos la opción rewrites para reenviar (proxy) solicitudes desde tu dominio principal hacia tu documentación. Las reglas de reescritura asignan solicitudes entrantes a otros destinos sin cambiar la URL en el navegador. Cuando alguien visita yoursite.com/docs, Vercel obtendrá 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 con varios niveles, como /product/docs.

​
Estructura del repositorio

Tus archivos de documentación deben organizarse dentro de tu repositorio para ajustarse a la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté 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: A dónde se debe enrutar 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 reglas en tu archivo vercel.json.

​
Uso de proxies externos con Vercel

Si utilizas 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 de dominio de Vercel y la provisió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 requerida

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/* - Necesario para la verificación de certificados de Let’s Encrypt
  • /.well-known/vercel/* - Necesario para la verificación de dominios de Vercel
  • /mintlify-assets/_next/static/* - Necesario para los recursos estáticos
Estas rutas deben pasar directamente a tu despliegue 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 ese encabezado, las solicitudes de verificación fallarán.

​
Probar la configuración del proxy

Para verificar que tu 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 tu panel de Vercel.
  3. Verifica que la verificación del dominio se complete correctamente.