Passer au contenu principal
Configurez votre fichier vercel.json pour acheminer les requêtes de votre domaine principal vers votre documentation sur un sous-chemin.

Fichier vercel.json

Le fichier vercel.json définit la façon 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 dans votre fichier vercel.json pour faire transiter les requêtes de votre domaine principal vers votre documentation via un proxy. Les réécritures (rewrites) font correspondre les requêtes entrantes à différentes destinations sans modifier l’URL dans le navigateur. Quand 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 envoient les utilisateurs vers une URL complètement différente.

Configuration

Héberger sur le sous-chemin /docs

  1. Accédez à la page Custom domain setup dans votre Dashboard.
  2. Cliquez sur l’interrupteur Host at /docs pour l’activer.
    Capture d’écran de la page Custom domain setup. L’interrupteur Host at `/docs` est activé et mis en évidence par un rectangle orange.
  3. Saisissez votre domaine.
  4. Sélectionnez Add domain.
  5. Ajoutez les réécritures suivantes à votre fichier vercel.json. Remplacez [subdomain] par votre sous-domaine, que vous trouverez à la fin de l’URL de votre Dashboard. Par exemple, dashboard.mintlify.com/your-organization/your-subdomain possède un identifiant de domaine your-subdomain.
    {
      "rewrites": [
        {
          "source": "/docs",
          "destination": "https://[subdomain].mintlify.dev/docs"
        },
        {
          "source": "/docs/:match*",
          "destination": "https://[subdomain].mintlify.dev/docs/:match*"
        }
      ]
    }
    
La configuration rewrites fait correspondre le sous-chemin /docs sur votre domaine au sous-chemin /docs sur votre documentation.
  • source : Le modèle de chemin sur votre domaine qui déclenche la réécriture.
  • destination : L’endroit où la requête doit être transmise en proxy.
  • :match* : Un joker qui capture tous les segments de chemin après votre sous-chemin.
Pour plus d’informations, consultez Configuring projects with vercel.json: Rewrites dans la documentation Vercel.

Héberger sur un sous-chemin personnalisé

Les sous-chemins personnalisés nécessitent une offre Custom et une configuration manuelle. Contactez le support Mintlify avec les détails du sous-chemin souhaité et de votre configuration d’hébergement.
Pour utiliser un sous-chemin personnalisé (tout chemin autre que /docs), vous devez organiser vos fichiers de documentation dans votre référentiel pour qu’ils correspondent à la structure de votre sous-chemin. Par exemple, si votre documentation est hébergée à l’adresse yoursite.com/help, vos fichiers de documentation doivent se trouver dans un répertoire help/. Utilisez le générateur ci-dessous pour créer votre configuration de réécritures. Ajoutez les réécritures à votre fichier vercel.json.