Saltar al contenido principal
Aloja tu documentación en tu propio dominio, como docs.example.com, o en una subruta de tu dominio, como example.com/docs. Para alojar tu documentación en un dominio personalizado:
  1. Añade tu dominio en tu dashboard.
  2. Configura los ajustes de DNS en tu proveedor de dominio.
  3. Espera a que el DNS se propague y a que los certificados TLS se aprovisionen automáticamente.

Elige dónde alojar tu documentación

Puedes alojar tu documentación en la raíz de un dominio, en un subdominio o en una subruta. Dominio o subdominio: Aloja tu documentación en un dominio como example.com o en un subdominio como docs.example.com. Mintlify sirve todo el tráfico del dominio o subdominio. Alojar en un dominio sin subdominio requiere un proveedor de DNS que admita el aplanamiento de CNAME o registros ALIAS. Consulta Dominios apex. Subruta: Aloja tu documentación en una ruta dentro de tu dominio, como example.com/docs. Habilita el interruptor Host at al añadir tu dominio e ingresa tu ruta base. Cómo llega el tráfico a Mintlify depende de tu DNS:
  • Si el DNS de tu dominio apunta a Mintlify, Mintlify sirve tu documentación en tu subruta. Solo apunta tu dominio a Mintlify si no aloja ningún otro contenido y Mintlify puede recibir todas las rutas del dominio.
  • Si otro sitio se ejecuta en tu dominio, tu aplicación o CDN sigue recibiendo el tráfico del dominio y solo redirige tu subruta a Mintlify.
El alojamiento en subruta no es compatible con documentación que tenga autenticación habilitada.

Añade tu dominio personalizado

  1. Ve a la página de configuración de dominio personalizado en tu dashboard.
  2. Para alojar en una subruta, habilita el interruptor Host at e ingresa tu ruta base, como /docs.
  3. Ingresa tu nombre de dominio. Por ejemplo, docs.example.com o example.com.
  4. Haz clic en Add domain.
Si el tráfico de tu dominio se enruta a Mintlify, el dashboard muestra los registros DNS que debes añadir en tu proveedor de dominio. Si solo redireccionas tu subruta a Mintlify, el dashboard muestra guías de configuración de proxy inverso en su lugar. Sigue la guía correspondiente a tu proveedor y consulta Alojar la documentación en una subruta para más información.

Requisitos de la ruta base

Tu ruta base puede ser cualquier ruta que cumpla estos requisitos:
  • Comienza con / y no contiene espacios, cadenas de consulta ni almohadillas.
  • Tiene como máximo 128 caracteres.
  • No es una ruta reservada por Mintlify: /_next, /_mintlify, /_sites, /_live-preview, /api, /login, /logout, /mcp, /feedback, /openapi-specs.download, /llms.txt, /llms-full.txt, /sitemap.xml, /robots.txt, /skill.md y /.well-known.

Cambia tu ruta base

Cuando cambias tu ruta base o subruta, Mintlify reconstruye y vuelve a desplegar tu sitio. Tu sitio permanece en línea en la ruta actual hasta que finaliza el despliegue, y luego el tráfico cambia a la nueva ruta. Si el despliegue falla, tu sitio sigue sirviéndose desde la ruta actual y puedes reintentar el cambio desde tu dashboard.

Configura tu DNS

Cada proveedor de dominio tiene diferentes formas de añadir registros DNS. Consulta la documentación de tu proveedor de dominio para obtener instrucciones específicas.
  1. En el sitio web de tu proveedor de dominio, ve a la configuración de DNS de tu dominio.
  2. Crea los registros DNS que se muestran en tu dashboard.
El dashboard muestra registros TXT de verificación y un registro CNAME:
TXT | _acme-challenge.<your-domain> | <value shown in your dashboard>
TXT | _cf-custom-hostname.<your-domain> | <value shown in your dashboard>
CNAME | <your-domain> | cname.mintlify.builders
El registro _acme-challenge autoriza a Let’s Encrypt a emitir un certificado TLS para tu dominio, y el registro _cf-custom-hostname verifica que controlas el dominio.
Añade primero tus registros TXT. No añadas ni cambies tu CNAME hasta que ambos registros TXT de verificación aparezcan como verificados en tu dashboard. Cada uno se muestra con una marca verde cuando el DNS es correcto. El dashboard verifica los registros TXT antes de que pueda completarse el aprovisionamiento del certificado. Cambiar el CNAME demasiado pronto suele romper HTTPS hasta que finaliza el aprovisionamiento.Si estás migrando un dominio existente y quieres cero tiempo de inactividad, publica primero los registros TXT de verificación y espera a que aparezcan como verificados y a que TLS se preaprovisione antes de apuntar el CNAME a Mintlify.Este flujo de prevalidación no funciona para dominios que pasan por el proxy de Cloudflare. Consulta Dominios detrás del proxy de Cloudflare.
El dashboard consulta el DNS en segundo plano y marca cada registro con una marca verde una vez que verifica el valor esperado. Después de guardar los registros en tu proveedor de DNS, espera un breve tiempo de propagación antes de que se actualicen los estados.

Dominios apex

Si alojas tu documentación en un dominio apex como example.com sin subdominio, tu proveedor de DNS debe admitir el aplanamiento de CNAME o un tipo de registro virtual como ALIAS o ANAME. El DNS estándar no permite un registro CNAME en el apex de un dominio, por lo que los proveedores que no cuentan con este soporte no pueden crear el registro que se muestra en tu dashboard. Los proveedores que admiten registros CNAME en el apex incluyen Cloudflare (aplanamiento de CNAME), Amazon Route 53 (registros alias), DNSimple (registros ALIAS) y Porkbun (registros ALIAS). Si tu proveedor no admite ninguna de estas opciones, aloja tu documentación en un subdominio como docs.example.com.

Propagación de DNS

Los cambios de DNS suelen tardar entre 1 y 24 horas en propagarse globalmente, aunque en algunos casos pueden tardar hasta 48 horas. Usa una herramienta como DNSChecker para verificar que la configuración de tu DNS sea correcta. Una vez que tus registros DNS estén activos, tu documentación es accesible primero mediante HTTP. HTTPS estará disponible después de que Mintlify aprovisione tu certificado TLS.

Aprovisionamiento automático de TLS

Después de añadir tus registros TXT y de que tus registros DNS se resuelvan correctamente, Mintlify genera un certificado SSL/TLS gratuito para tu sitio usando Let’s Encrypt. Esto normalmente se completa en unas pocas horas tras la propagación del DNS, aunque en casos poco frecuentes puede tardar hasta 24 horas. Los certificados se renuevan automáticamente antes de su caducidad.

Registros CAA

Si tu dominio utiliza registros CAA (Certification Authority Authorization), debes autorizar a Let’s Encrypt a emitir certificados para tu dominio. Añade el siguiente registro CAA a la configuración de tu DNS:
0 issue "letsencrypt.org"

Rutas reservadas

Mintlify reserva la ruta /.well-known/acme-challenge para la validación de certificados. No puedes redirigir ni reescribir esta ruta. Si has configurado redirecciones o reescrituras para esta ruta, el aprovisionamiento del certificado falla.

Dominios detrás del proxy de Cloudflare

Si tu dominio ya pasa por el proxy de Cloudflare (el estado del proxy muestra una nube naranja), los registros TXT de verificación no pueden aparecer como verificados antes de que actualices tu CNAME. Esto ocurre incluso cuando los registros se resuelven correctamente con herramientas como dig o DNSChecker. El proxy de Cloudflare impide que la verificación se complete hasta que el tráfico del hostname se enrute a Mintlify. Para dominios detrás del proxy de Cloudflare, sigue estos pasos:
  1. Añade los registros TXT de verificación en tu proveedor de DNS.
  2. Actualiza tu registro CNAME para que apunte a cname.mintlify.builders sin esperar a que los registros TXT aparezcan como verificados.
  3. Espera a que se complete la verificación y el aprovisionamiento de TLS. Es posible que tu sitio sirva brevemente un certificado no válido durante el aprovisionamiento.
Si necesitas cero tiempo de inactividad durante la migración, establece el estado del proxy del registro CNAME en DNS only (nube gris). Esto permite que el flujo estándar de prevalidación se complete antes de que cambies el tráfico.

Configuraciones específicas del proveedor

Si Cloudflare es tu proveedor de DNS, debes habilitar el modo “Full (strict)” para la configuración de cifrado SSL/TLS. Además, desactiva “Always Use HTTPS” en la configuración de Edge Certificates. La redirección HTTPS de Cloudflare impide que Let’s Encrypt valide tu dominio durante el aprovisionamiento del certificado.

Reintentar la validación

Los registros TXT suelen validarse en cinco minutos. Si tu dominio sigue pendiente de validación después de añadir los registros TXT de verificación, reintenta la validación manualmente desde tu dashboard.
  1. Ve a la página de configuración de dominio personalizado en tu dashboard.
  2. Busca tu dominio personalizado pendiente.
  3. Haz clic en Retry validation.
Reintenta la validación solo después de confirmar que tus registros DNS son correctos. Los reintentos repetidos con registros incorrectos no aceleran la validación.

Elimina un dominio personalizado

Para eliminar un dominio personalizado, haz clic en el icono de eliminar junto a tu dominio en la página de configuración de dominio personalizado y confirma la eliminación. Los enlaces existentes al dominio pueden romperse y volver a añadir el dominio puede requerir reconfigurar tus registros DNS.

Establece una URL canónica

Después de configurar tu DNS, establece una URL canónica para asegurarte de que los motores de búsqueda indexen tu dominio preferido. Una URL canónica indica a los motores de búsqueda qué versión de tu documentación es la principal. Esto mejora el SEO cuando tu documentación es accesible desde varias URL y evita problemas de contenido duplicado. Añade la metaetiqueta canonical a tu docs.json:
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}
Reemplaza https://www.your-custom-domain-here.com con tu dominio personalizado real. Por ejemplo, si tu dominio personalizado es docs.mintlify.com, usarías:
"seo": {
    "metatags": {
        "canonical": "https://docs.mintlify.com"
    }
}