Aller au contenu principal
Version : 2.4.3

📦 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.

production only

This plugin is always inactive in development and only active in production because it works on the build output.

Installation​

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

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

Configuration​

Champs acceptés :

NomTypePar défautDescription
changefreqstring'weekly'See sitemap docs
prioritynumber0.5See sitemap docs
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: results in no sitemap generated
  • trailingSlash: determines if the URLs in the sitemap have trailing slashes

Example 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',
},
},
],
],
};

You can find your sitemap at /sitemap.xml.