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

• Limitez-les à 60 caractères pour éviter la troncature dans les résultats de recherche
• Incluez votre mot-clé principal en début de titre
• Rendez chaque titre unique dans toute votre documentation

Descriptions

• Visez 120 à 160 caractères
• Résumez ce que le lecteur va apprendre
• Intégrez 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 en brouillon ou en cours de rédaction
• La documentation interne
• Le contenu obsolète que vous conservez à titre de référence

URL canoniques

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

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

Vous pouvez également définir une base canonique globale dans docs.json. Jamdesk y ajoute le chemin de chaque page, ce qui donne une URL canonique correcte par page :

{
  "seo": {
    "metatags": {
      "canonical": "https://docs.acme.com"
    }
  }
}

Aperçus sociaux & Open Graph

Jamdesk génère automatiquement une carte sociale 1200×630 pour chaque page. Vous pouvez remplacer n'importe quelle balise sociale dans le frontmatter, en utilisant des clés plates de premier niveau ou un bloc seo: imbriqué. Les deux fonctionnent ; si la même clé est définie des deux façons, la valeur plate de premier niveau prend la priorité.

---
title: API Reference
description: REST API endpoints and authentication
"og:title": API Reference — Acme
"og:description": Everything you need to call the Acme API
"og:image": /images/api-social-card.png
"twitter:card": summary_large_image
"twitter:creator": "@acme"
keywords: ["api", "rest", "authentication"]
canonical: https://docs.acme.com/api-reference
---

---
title: API Reference
description: REST API endpoints and authentication
seo:
  "og:title": API Reference — Acme
  "og:image": /images/api-social-card.png
  "twitter:card": summary_large_image
  x-custom-tag: any custom meta value
---

Balises prises en charge

Image par défaut à l'échelle du site

Définissez une image sociale de secours pour toutes les pages dans docs.json. Toute page qui définit son propre og:image remplace cette valeur :

{
  "seo": {
    "metatags": {
      "og:image": "https://docs.acme.com/images/default-card.png"
    }
  }
}

Sitemap & Robots.txt

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

Où les trouver

Les URL dépendent de si votre documentation se trouve à la racine d'un domaine 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
• Fréquence de modification hebdomadaire

Exclure des pages du sitemap

Ajoutez noindex dans le frontmatter pour exclure une page à la fois 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 de votre site, l'URL et la description (issus de docs.json).
• BreadcrumbList : le chemin de navigation de la page d'accueil à la page courante, dérivé de votre configuration navigation.

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

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 les 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 réellement modifiées
• Non bloquant, n'allonge jamais la durée du build
• Aucune configuration requise

Bonnes pratiques

Parcourez cette liste de contrôle avant de publier :

Articles associés