Vercel

Implementa la documentación en una subruta en Vercel.

Configura tu archivo vercel.json para reenviar mediante un proxy las solicitudes desde tu dominio principal a tu documentación en una subruta.

​

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, como el enrutamiento, las redirecciones, los encabezados y la configuración de compilación.

Usamos la configuración de rewrites en tu archivo vercel.json para enrutar las solicitudes desde tu dominio principal hacia tu documentación mediante un proxy.

Las reglas de reescritura (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 desde 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.

​

Configuración

​

Alojar en la subruta /docs

1. Navega a Custom domain setup en tu dashboard.

2. Haz clic en el interruptor Host at /docs para activarlo.

   

3. Ingresa tu dominio.

4. Selecciona Add domain.

5. Agrega las siguientes reglas de reescritura a tu archivo vercel.json. Sustituye [subdomain] por tu subdominio, que se encuentra al final de la URL de tu dashboard. Por ejemplo, dashboard.mintlify.com/your-organization/your-subdomain tiene un identificador de dominio de your-subdomain.

   {
     "rewrites": [
       {
         "source": "/docs",
         "destination": "https://[subdomain].mintlify.dev/docs"
       },
       {
         "source": "/docs/:match*",
         "destination": "https://[subdomain].mintlify.dev/docs/:match*"
       }
     ]
   }
   

La configuración de rewrites asigna la subruta /docs en tu dominio a la subruta /docs en tu documentación.

• source: El patrón de ruta en tu dominio que activa la reescritura.
• destination: Adonde 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.

​

Hospedar en una subruta personalizada

Las subrutas personalizadas requieren un plan Custom y una configuración manual. Ponte en contacto con el equipo de soporte de Mintlify con los detalles sobre la subruta y la configuración de alojamiento que deseas.

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 la subruta. Por ejemplo, si tu documentación se aloja en yoursite.com/help, los archivos de tu documentación deben estar en un directorio help/.

Utiliza el generador a continuación para crear tu configuración de rewrites. Añade estas reglas de rewrites a tu archivo vercel.json.