Optimisation SEO

Optimisez votre documentation pour les moteurs de recherche et les aperçus sociaux en définissant les titres, descriptions et métadonnées dans le frontmatter.

Ce que Jamdesk fait automatiquement

Optimiser votre contenu

Rédiger un frontmatter efficace

---
title: User Authentication    # Under 60 characters
description: Set up OAuth, JWT, and session-based authentication  # 120-160 characters
---

Titres de page

• Restez sous 60 caractères pour éviter la troncature dans les résultats de recherche
• Incluez votre mot-clé principal dès le début
• Rendez chaque titre unique dans votre documentation

Descriptions

• Visez 120 à 160 caractères
• Résumez ce que le lecteur va apprendre
• Incluez les mots-clés pertinents de façon naturelle

Contrôler l'indexation

Paramètres globaux du site

Dans votre docs.json, configurez le comportement par défaut des robots :

{
  "seo": {
    "metatags": {
      "robots": "index, follow"
    }
  }
}

Contrôle par page

Remplacez l'indexation pour des pages spécifiques dans le frontmatter :

---
title: Internal Notes
noindex: true
---

Utilisez noindex pour :

• Les pages brouillon ou en cours de rédaction
• La documentation interne
• Le contenu obsolète que vous conservez pour référence

URL canoniques

Si votre documentation est accessible à plusieurs URL, définissez une URL canonique :

---
title: Getting Started
canonical: https://docs.example.com/getting-started
---

Personnalisation d'Open Graph

Remplacez l'image sociale générée automatiquement :

---
title: API Reference
og:image: /images/api-social-card.png
---

Sitemap & Robots.txt

Chaque site Jamdesk génère automatiquement un sitemap.xml et un robots.txt à chaque build.

Où les trouver

Les URL dépendent de si votre documentation est hébergée à un domaine racine ou sous un sous-chemin /docs :

https://docs.acme.com/sitemap.xml
https://docs.acme.com/robots.txt

Contenu du sitemap

• Toutes les pages publiées (à l'exclusion de celles avec le frontmatter noindex ou hidden)
• Les dates de dernière modification issues du frontmatter lorsqu'elles sont disponibles
• Une fréquence de modification hebdomadaire

Exclure des pages du sitemap

Ajoutez noindex au frontmatter pour exclure une page du sitemap et des moteurs de recherche :

---
title: Internal Notes
noindex: true
---

Les pages avec hidden: true sont également exclues automatiquement.

Données structurées JSON-LD

Chaque page inclut automatiquement des données structurées schema.org sous forme de balise <script type="application/ld+json"> avec deux schémas :

• WebSite : le nom, l'URL et la description de votre site (issus de docs.json).
• BreadcrumbList : le chemin de navigation de la page d'accueil à la page actuelle, dérivé de votre configuration navigation.

Aucune configuration requise. Les moteurs de recherche utilisent ces données pour des résultats enrichis comme les fils d'Ariane dans les listes de résultats.

IndexNow

Après chaque build, Jamdesk soumet automatiquement les URL de pages modifiées à IndexNow pour une indexation plus rapide par les moteurs de recherche. Cela notifie Bing, Yandex et d'autres moteurs participants de vos modifications de contenu sans attendre leur prochain cycle d'exploration.

• Se déclenche après chaque build réussi
• Ne soumet que les pages ayant réellement changé
• Non bloquant, ne retarde donc jamais votre build
• Aucune configuration requise

Bonnes pratiques

Articles connexes