13. Comment utiliser les liens internes et externes

Comment utiliser les liens internes et externes

Naviguer facilement dans votre documentation grâce aux liens

Pourquoi utiliser des liens ?

Les liens permettent :

• de connecter vos pages entre elles

• d’aider le lecteur à naviguer

• de créer un parcours logique

• d’éviter les répétitions inutiles

Une documentation bien liée est plus fluide et plus agréable à lire.

Les deux types de liens

Dans Mintlify, vous pouvez utiliser :

• des liens internes (vers vos propres pages)

• des liens externes (vers d’autres sites)

Les deux sont importants pour guider le lecteur.

Comment créer un lien interne ?

Un lien interne sert à renvoyer vers une autre page de votre documentation.

Il est utile pour :

• renvoyer vers une explication plus détaillée

• éviter de répéter une information

• créer un parcours d’apprentissage

Les liens internes fonctionnent avec un chemin simple vers une autre page.

Quand utiliser un lien interne ?

• pour renvoyer vers une page déjà expliquée

• pour guider le lecteur vers une étape suivante

• pour connecter deux sujets liés

• pour éviter de dupliquer du contenu

Une bonne documentation utilise beaucoup de liens internes.

Comment créer un lien externe ?

Un lien externe sert à renvoyer vers :

• une documentation officielle

• un site de référence

• un outil externe

• une ressource complémentaire

Les liens externes sont utiles pour enrichir votre contenu.

Bonnes pratiques pour les liens

• utilisez des liens courts et clairs

• évitez les liens trop techniques dans le texte

• ne mettez pas trop de liens dans un seul paragraphe

• vérifiez que les liens fonctionnent après publication

• utilisez les liens internes pour guider, et les externes pour compléter

Une documentation bien liée est plus facile à parcourir.

Erreurs fréquentes

• mettre des liens vers des pages qui n’existent pas

• utiliser des chemins incorrects

• renvoyer vers des pages non ajoutées dans la sidebar

• mettre trop de liens dans une seule phrase

• utiliser des liens externes pour des informations internes

Un lien mal placé peut perdre le lecteur.

Résumé

Les liens internes permettent de connecter vos pages entre elles.

Les liens externes enrichissent votre documentation avec des ressources utiles.

Bien utilisés, ils rendent votre site plus clair, plus logique et plus professionnel.

Pour aller plus loin

• Documentation Mintlify : https://mintlify.com/docs

• Bonnes pratiques UX : https://developer.mozilla.org