Docsbook
Aperçu

Domaine personnalisé pour la documentation : docs.yourcompany.com configuration

docs.yourcompany.com a l'air plus professionnel que docsbook.io/yourorg/yourrepo. Cela compte également pour le SEO, la confiance et la première impression "est-ce un vrai produit". Voici comment le configurer correctement.

TL;DR#

  1. Décidez du sous-domaine (docs.yourcompany.com) contre le sous-répertoire (yourcompany.com/docs/)
  2. Ajoutez un enregistrement CNAME ou A dans le DNS pointant vers votre hôte de documentation
  3. Attendez que le SSL soit provisionné (généralement moins de 5 minutes)
  4. Configurez des redirections depuis toute URL précédente
  5. Mettez à jour les liens internes et les mentions externes

Sous-domaine vs sous-répertoire#

Le débat sur le SEO est réel. Les deux fonctionnent en 2026, mais ils ont des compromis différents.

Sous-domaine (docs.yourcompany.com) Sous-répertoire (yourcompany.com/docs/)
Complexité de configuration Plus facile (un enregistrement DNS) Plus difficile (proxy inverse ou plateforme partagée)
Autorité SEO Principalement héritée du domaine racine Entièrement héritée
Flexibilité d'hébergement Indépendant du site principal Partage l'infrastructure du site principal
Cohésion de marque Séparation claire Étroitement couplé
Commun en 2026 La plupart des sites de documentation Stripe, GitHub, AWS

Pour la plupart des équipes, le sous-domaine est plus facile et la différence SEO est faible. N'utilisez un sous-répertoire que si votre site principal est sur une plateforme qui prend en charge le proxy inverse de manière propre.

Configuration du sous-domaine (exemple Docsbook)#

Trois étapes :

1. Dans le tableau de bord Docsbook#

  • Ouvrez les paramètres de votre espace de travail
  • Paramètres → Domaine
  • Entrez docs.yourcompany.com
  • Cliquez sur Enregistrer

Le tableau de bord affiche les enregistrements DNS que vous devez ajouter.

2. Dans votre fournisseur DNS#

Ajoutez un enregistrement CNAME :

Type:  CNAME
Name:  docs
Value: cname.vercel-dns.com
TTL:   300 (or default)

Si votre fournisseur DNS ne prend pas en charge CNAME à la racine (aplatissement de Cloudflare ou similaire), utilisez l'alternative d'enregistrement A que votre plateforme fournit.

3. SSL#

SSL est automatique. Docsbook (via Vercel) fournit un certificat Let's Encrypt en 5 minutes. Vous verrez le statut "Actif" dans le tableau de bord.

Temps total : généralement 5 à 15 minutes, y compris la propagation DNS.

Lorsque SSL prend plus de temps#

Si SSL reste "En attente" après 30 minutes :

  • Vérifiez que le DNS a été propagé globalement : dig docs.yourcompany.com doit résoudre vers la cible CNAME
  • Supprimez tous les enregistrements CAA qui bloquent Let's Encrypt
  • Vérifiez que votre domaine ne sert pas déjà HTTPS d'un autre fournisseur

Redirections#

Si vous avez précédemment hébergé des documents à une URL différente, configurez des redirections 301 pour préserver le SEO.

D'un sous-répertoire de docs vers le nouveau sous-domaine#

yourcompany.com/docs/* → docs.yourcompany.com/* (301)

La plupart des plateformes prennent en charge cela via des règles de redirection.

De GitBook v-paths à Docsbook#

Les URL de GitBook ont généralement des motifs /v/1.0/ :

docs.yourcompany.com/v/1.0/api/auth → docs.yourcompany.com/api/auth (301)

Si vous utilisez Cloudflare devant votre domaine, vous pouvez le faire avec une seule règle de page. Voir la migration de GitBook à Docsbook.

De Docusaurus préfixe à racine#

Docusaurus utilise souvent /docs/intro chemins. Si vous aplatissez à la racine :

docs.yourcompany.com/docs/* → docs.yourcompany.com/* (301)

Voir la migration de Docusaurus vers Docsbook.

Considérations SEO#

Trois choses à vérifier après le basculement :

Console de recherche#

Ajoutez le nouveau domaine à Google Search Console. Soumettez le plan du site (Docsbook génère automatiquement /sitemap.xml). Surveillez le rapport d'indexation pendant 4 à 6 semaines.

Balises canoniques#

Si vous maintenez l'ancienne URL active comme solution de secours pour une raison quelconque, définissez des balises canoniques sur l'ancienne URL pointant vers la nouvelle. Une redirection 301 est encore mieux, car elle déplace à la fois les lecteurs et les signaux de classement.

llms.txt propagation#

Lorsque vous déplacez un domaine, les agents IA doivent redécouvrir votre llms.txt. Ils le font généralement en quelques explorations. Vérifiez :

curl https://docs.yourcompany.com/llms.txt | head -10

Voir le guide complet de llms.txt.

Quelles sont les modifications pour les utilisateurs#

  • Favoris vers d'anciennes URL : couverts par des redirections
  • Réponses de support enregistrées : mettez-les à jour
  • Liens internes vers le produit : mettez-les à jour
  • Liens externes : restent (le 301 transfère l'autorité)

L'expérience visible par l'utilisateur ne devrait pas changer au-delà de l'URL.

Support de domaine personnalisé par plateforme#

Plateforme Domaine personnalisé pris en charge Coût
Docsbook Oui, avec SSL automatique Rien — le domaine ne tire rien du solde du projet ; voir docsbook.io/pricing
Mintlify Oui Sur un plan payant — voir mintlify.com/pricing
GitBook Oui Sur un plan payant — voir gitbook.com/pricing
ReadMe Oui Sur un plan payant — voir readme.com/pricing
GitHub Pages Oui Gratuit
Vercel / Netlify Oui Niveau gratuit, avec des limites de domaine par compte

Les prix dans cette catégorie varient ; la page de tarification de chaque fournisseur est la seule source fiable, et ce tableau renvoie à toutes plutôt que de répéter des chiffres qui deviennent obsolètes.

Erreurs courantes#

  • Pointer le domaine apex vers un CNAME — la plupart des fournisseurs DNS ne le permettent pas ; utilisez un sous-domaine (docs.) ou un enregistrement A aplati
  • Oublier de rediriger — anciennes URL 404 → chute du SEO → perte d'autorité
  • HTTPS non appliqué — certaines plateformes servent à la fois HTTP et HTTPS ; forcer la redirection vers HTTPS
  • Plusieurs docs sous-domaines — un seul CNAME à la fois, supprimer d'abord les anciens

Docsbook sert docs.yourcompany.com avec SSL automatique, et le domaine ne tire rien de votre solde de projet.

Commencer gratuitement — pas de carte de crédit

Updated

Cette page vous a-t-elle été utile ?