Passer au contenu principal

​
Fichier vercel.json

Le fichier vercel.json définit la manière dont votre projet est construit et déployé. Il se trouve à la racine de votre projet et contrôle divers aspects de votre déploiement, notamment le routage, les redirections, les en-têtes et les paramètres de build. Nous utilisons la configuration rewrites pour faire transiter (proxy) les requêtes de votre domaine principal vers votre documentation. Les réécritures redirigent les requêtes entrantes vers d’autres destinations sans modifier l’URL affichée dans le navigateur. Lorsque quelqu’un visite yoursite.com/docs, Vercel récupère en interne le contenu depuis your-subdomain.mintlify.dev/docs, mais l’utilisateur voit toujours yoursite.com/docs dans son navigateur. Cela diffère des redirections, qui enverraient les utilisateurs vers une autre URL. Vous pouvez personnaliser le sous-chemin avec la valeur de votre choix, comme /docs, /help ou /guides. Vous pouvez également utiliser des sous-chemins profondément imbriqués comme /product/docs.

​
Structure du référentiel

Vos fichiers de documentation doivent être organisés dans votre référentiel afin de correspondre à la structure de sous-chemin que vous avez choisie. Par exemple, si vous souhaitez que votre documentation se trouve à yoursite.com/docs, vous devez créer un répertoire docs/ contenant tous vos fichiers de documentation.

​
Configuration

Pour héberger votre documentation à un sous-chemin personnalisé avec Vercel, ajoutez la configuration suivante à votre fichier vercel.json. Cet exemple utilise /docs, mais vous pouvez le remplacer par n’importe quel sous-chemin : 
{
  "rewrites": [
    {
      "source": "/docs",
      "destination": "https://[subdomain].mintlify.dev/docs"
    },
    {
      "source": "/docs/:match*",
      "destination": "https://[subdomain].mintlify.dev/docs/:match*"
    }
  ]
}
  • source: Le modèle de chemin sur votre domain qui déclenche la réécriture.
  • destination: La destination vers laquelle la requête doit être mise en proxy.
  • :match*: Un caractère générique qui capture tous les segments de chemin après votre sous-chemin.
Pour en savoir plus, consultez Configuring projects with vercel.json: Rewrites dans la documentation Vercel.

​
Générer des règles de réécriture

Saisissez votre sous-domaine et votre sous-répertoire personnalisé pour générer les règles de réécriture de votre fichier vercel.json.

​
Utiliser des proxys externes avec Vercel

Si vous utilisez un proxy externe (comme Cloudflare ou AWS CloudFront) devant votre déploiement Vercel, vous devez le configurer correctement pour éviter les conflits avec la vérification de domaine par Vercel et la délivrance des certificats SSL. Une configuration de proxy incorrecte peut empêcher Vercel d’émettre des certificats SSL Let’s Encrypt et provoquer des échecs de vérification de domaine. Consultez les fournisseurs pris en charge dans la documentation de Vercel.

​
Liste d’autorisation des chemins requis

Votre proxy externe doit autoriser le trafic vers ces chemins spécifiques sans le bloquer, le rediriger ni le mettre fortement en cache :
  • /.well-known/acme-challenge/* - Requis pour la vérification du certificat Let’s Encrypt
  • /.well-known/vercel/* - Requis pour la vérification du domain Vercel
  • /mintlify-assets/_next/static/* - Requis pour les ressources statiques
Ces chemins doivent être transmis directement à votre déploiement Vercel sans modification.

​
Exigences de transfert des en-têtes

Assurez-vous que votre proxy transmet correctement l’en-tête HOST. Sans un transfert correct des en-têtes, les requêtes de vérification échoueront.

​
Tester la configuration de votre proxy

Pour vérifier que votre proxy est correctement configuré :
  1. Vérifiez que https://[yourdomain].com/.well-known/vercel/ renvoie une réponse.
  2. Assurez-vous que les certificats SSL sont correctement provisionnés dans votre Dashboard Vercel.
  3. Vérifiez que la vérification du domain s’effectue correctement.
⌘I