Aller au contenu principal
Version : 2.2.0

📦 plugin-sitemap

Ce plugin crée des sitemaps pour votre site afin que les robots des moteurs de recherche puissent explorer votre site avec plus de précision.

seulement en production

Ce plugin est toujours inactif en développement et uniquement actif en production car il fonctionne sur la sortie de la construction.

Installation​

npm install --save @docusaurus/plugin-sitemap
astuce

Si vous utilisez le preset @docusaurus/preset-classic, vous n'avez pas besoin d'installer ce plugin en tant que dépendance.

Vous pouvez configurer ce plugin via les options du preset.

Configuration​

Champs acceptés :

NomTypePar défautDescription
changefreqstring'weekly'Consultez les docs de sitemap
prioritynumber0.5Consultez les docs de sitemap
ignorePatternsstring[][]Une liste de patterns de glob; les chemins de route correspondants seront filtrés du sitemap. Notez que vous devrez peut-être inclure l'URL de base ici.
filenamestringsitemap.xmlLe chemin vers le fichier sitemap créé, relatif au répertoire de sortie. Utile si vous avez deux instances de plugin qui sortent deux fichiers.
info

Ce plugin respecte également la configuration de certains sites :

  • noIndex : ne génère aucun sitemap
  • trailingSlash: détermine si les URL dans le sitemap ont des slashes finaux

Exemple de configuration​

Vous pouvez configurer ce plugin via les options du preset ou du plugin.

astuce

La plupart des utilisateurs de Docusaurus configurent ce plugin via les options du preset.

Si vous utilisez un preset, configurez ce plugin via le options du preset :

docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
sitemap: {
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
},
},
],
],
};

Vous pouvez trouver votre sitemap sur /sitemap.xml.