Vercel

Aloja la documentación en una subruta personalizada con Vercel

​

Archivo vercel.json

El archivo vercel.json configura cómo se compila e implementa tu proyecto. Se encuentra en el directorio raíz de tu proyecto y controla varios aspectos de la implementación, incluidos el enrutamiento, las redirecciones, los encabezados y los ajustes de compilación.

Usamos la configuración de rewrites para enrutar mediante proxy las solicitudes desde tu domain principal hacia tu documentación.

Los rewrites asignan las solicitudes entrantes a distintos destinos sin cambiar la URL en el navegador. Cuando alguien visita yoursite.com/docs, Vercel obtiene internamente el contenido de your-subdomain.mintlify.dev/docs, pero el usuario sigue viendo yoursite.com/docs en su navegador. Esto es diferente de las redirecciones, que envían a los usuarios a otra URL por completo.

Puedes personalizar la subruta con cualquier valor que prefieras, como /docs, /help o /guides. Además, puedes usar subrutas anidadas en varios niveles, como /product/docs.

​

Configuración

​

Alojar desde /docs

1. Ve a Configuración de dominio personalizado en tu dashboard.
2. Activa el interruptor Host at /docs.

3. Ingresa tu domain.
4. Selecciona Add domain.
5. Agrega las siguientes reglas de reescritura a tu archivo vercel.json. Reemplaza [subdomain] con tu subdomain:

  {
    "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 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.

​

Hospedar desde una ruta personalizada

Para usar una subruta personalizada (cualquier ruta distinta de /docs), debes organizar los archivos de tu documentación dentro de tu repositorio para que coincidan con la estructura de esa subruta. Por ejemplo, si tu documentación se hospeda en yoursite.com/help, los archivos de la documentación deben estar en el directorio help/.

Usa el generador a continuación para crear la configuración de rewrites. Agrega los rewrites a 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.