@docusaurus/plugin-sitemap
Advanced tools
@docusaurus/plugin-sitemap is a plugin for Docusaurus, a popular static site generator. This plugin helps in generating a sitemap for your Docusaurus site, which is essential for SEO as it helps search engines to crawl and index your site more effectively.
Generate Sitemap
This feature allows you to generate a sitemap for your Docusaurus site. You can configure the change frequency and priority for the URLs in the sitemap.
module.exports = {
plugins: [
'@docusaurus/plugin-sitemap',
{
id: 'default',
changefreq: 'weekly',
priority: 0.5,
},
],
};Custom Sitemap Path
This feature allows you to specify a custom path for the generated sitemap file. By default, the sitemap is saved as 'sitemap.xml', but you can change it to any filename you prefer.
module.exports = {
plugins: [
'@docusaurus/plugin-sitemap',
{
id: 'default',
changefreq: 'weekly',
priority: 0.5,
sitemapFilename: 'custom-sitemap.xml',
},
],
};Exclude Specific URLs
This feature allows you to exclude specific URLs or patterns from the sitemap. This is useful if you have pages that you do not want to be indexed by search engines.
module.exports = {
plugins: [
'@docusaurus/plugin-sitemap',
{
id: 'default',
changefreq: 'weekly',
priority: 0.5,
exclude: ['/exclude-this-page', '/exclude-this-directory/*'],
},
],
};The 'sitemap' package is a general-purpose sitemap generator for Node.js. It offers more flexibility and can be used with any static site generator or web framework. Unlike @docusaurus/plugin-sitemap, it is not specifically tailored for Docusaurus and requires more manual setup.
The 'next-sitemap' package is designed specifically for Next.js applications. It provides similar functionalities like generating sitemaps, setting change frequencies, and excluding specific URLs. However, it is tailored for Next.js and not for Docusaurus.
The 'gatsby-plugin-sitemap' package is a plugin for Gatsby, another popular static site generator. It offers similar functionalities such as generating sitemaps and excluding specific URLs. It is specifically designed for Gatsby and not for Docusaurus.
FAQs
Simple sitemap generation plugin for Docusaurus.
We found that @docusaurus/plugin-sitemap demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.