Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
By Sarah Gooding - Feb 07, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@docusaurus/plugin-sitemap
Advanced tools
What is @docusaurus/plugin-sitemap?
@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.
What are @docusaurus/plugin-sitemap's main functionalities?
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/*'],
},
],
};Other packages similar to @docusaurus/plugin-sitemap
sitemap
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.
next-sitemap
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.
gatsby-plugin-sitemap
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.
The README file is missing
2.0.0-alpha.70 (2020-12-17)
:rocket: New Feature
docusaurusdocusaurus-module-type-aliases,docusaurus-theme-classic,docusaurus-types,docusaurusdocusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-theme-bootstrap,docusaurus-theme-classic,docusaurus-typesdocusaurus-plugin-content-docs- #3888 feat(v2): add custom props for consumption by swizzled sidebar (@oriooctopus)
docusaurus-plugin-content-blog- Other
- #3827 feat(v2): add automated canary releases (@slorber)
- #3761 feat(v2): Added Lighthouse CI to PR checks (@sarthakkundra)
docusaurus-1.x,docusaurus-module-type-aliases,docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-theme-classic,docusaurus-theme-common,docusaurus-theme-search-algolia,docusaurus-types,docusaurus-utils,docusaurus
:boom: Breaking Change
docusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-theme-bootstrap,docusaurus-theme-classic,docusaurus-typesdocusaurus-plugin-content-blog
:bug: Bug Fix
docusaurus- #3922 fix(v2): fix navbar items issue on Windows? (@slorber)
- #3920 fix(v2): i18n translation extractor should handle JSX formatting edge cases better (@slorber)
- #3896 fix(v2): do not treat at-rules during CSS minification (@lex111)
- #3869 fix(v2): load plugin commands async to fix broken plugin CLI commands
docs:version(@aeneasr)
docusaurus-theme-classic- #3921 fix(v2): remove useless console log (@slorber)
- #3895 fix(v2): use proper element for pagination nav label (@lex111)
- #3882 fix(v2): improve Footer structure, add class names, use Infima transition (@Simek)
- #3877 fix(v2): dynamic dark mode detection without toggle widget (@hmil)
- #3854 fix(v2): refactor icons in theme-classic, fix swizzle issue (@Simek)
- #3823 fix(v2): support rendering of singular tabs (@aeneasr)
- #3817 fix(v2): Allow footer logo at attribute to be empty (@aarongarciah)
docusaurus-theme-bootstrap,docusaurus-theme-classic- Other
stylelint-copyrightdocusaurus-theme-search-algolia- #3853 fix(v2): fix DocSearch keyboard navigator (@francoischalifour)
- #3837 fix(v2): update SearchPage styling, fix appearance in dark mode (@Simek)
- #3828 fix(v2): restore Algolia search (@lex111)
- #3819 feat(search): update DocSearch to alpha.31 (@francoischalifour)
docusaurus-plugin-content-docsdocusaurus-theme-classic,docusaurus-theme-search-algoliadocusaurus-init,docusaurus
:nail_care: Polish
:memo: Documentation
- #3931 docs(v2): blog.md with docs: false, for blog-only mode (@Romstar)
- #3924 docs(v2): Removed unnecessary closing parenthesis (@Varshit07)
- #3928 docs(v2): add FoalTS to showcase page (@LoicPoullain)
- #3899 docs(v2): Move sidebar content to its own page (@ArtFlag)
- #3856 docs(v2): typo (@borool)
- #3891 docs(v2): Wrap section about custom domains in :::info (@Alex1304)
- #3871 docs(v2): missing
<ColorGenerator/>mdx import (@slorber) - #3873 docs(v2): From docusaurus-migrate to @docusaurus/migrate (@manzinello)
- #3867 docs(v2): Add docusaurus-plugin-moesif to community plugins (@dgilling)
- #3851 docs(v2): Fixed Typo: Hided => Hidden (@woodrufs)
- #3832 docs(v2): Add wasp to showcase (@matijaSos)
- #3813 docs(v2): render deployment doc (@davidmauskop)
- #3835 docs(v2): update Client API docs page (@Simek)
- #3831 docs(v2): Docs refactoring and reorganization (@slorber)
:house: Internal
- Other
- #3912 chore(v2): remove docs for alpha v64 (@lex111)
- #3907 chore(ci): fix canary release filtering (@slorber)
- #3902 chore(deps): bump ini from 1.3.5 to 1.3.7 (@dependabot[bot])
- #3884 chore(ci): increase Lighthouse CI max_timeout (@Simek)
- #3883 chore(v2): remove docs for alpha v62-63 (@lex111)
- #3863 chore(ci): run V1 Build and Migration CLI tests conditionally on CI (@Simek)
- #3861 chore(ci): reduce number of jobs, remove build from lighthouse pipeline (@Simek)
- #3860 chore: add Yarn v2 cache directory to ignores (@Simek)
- #3858 chore(v2): disable Crowdin for deploy previews (@slorber)
- #3857 fix(v2): fix Crowdin ci commands (@slorber)
- #3849 chore(ci): CI scripts cleanup, add Node 14 runs, bump checkout action (@Simek)
- #3850 chore(v2): i18n CI: add write-translations call (@slorber)
- #3848 chore(v2): fix CI typo (@slorber)
- #3847 chore(v2): wire production Crowdin project + setup (@slorber)
- #3846 chore(v2): fix PRs not able to add lighthouse/buildsize comment from works (@slorber)
docusaurus-1.x,docusaurus-theme-bootstrap,docusaurus-theme-classicdocusaurus-cssnano-preset,docusaurus-mdx-loader,docusaurus-migrate,docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-plugin-sitemap,docusaurus-theme-classic,docusaurus-theme-common,docusaurus-types,docusaurus-utils-validation,docusaurus-utils,docusaurusdocusaurus-theme-bootstrap,docusaurus-theme-classic,docusaurus-theme-common,docusaurus-theme-search-algolia
Committers: 23
- Aarón García Hervás (@aarongarciah)
- Alex1304 (@Alex1304)
- Alexey Pyltsyn (@lex111)
- Arthur (@ArtFlag)
- Bartosz Kaszubowski (@Simek)
- Cindy Gu (@cindygu4)
- Derric Gilling (@dgilling)
- François Chalifour (@francoischalifour)
- Hadrien Milano (@hmil)
- Kaartic Sivaraam (@sivaraam)
- Loïc Poullain (@LoicPoullain)
- Matija Sosic (@matijaSos)
- Matteo Manzinello (@manzinello)
- Méril (@mpsq)
- Oliver Ullman (@oriooctopus)
- Rami (@Romstar)
- Sarthak kundra (@sarthakkundra)
- Stephen Woodruff (@woodrufs)
- Sébastien Lorber (@slorber)
- Varshit Shah (@Varshit07)
- @borool
- @davidmauskop
- hackerman (@aeneasr)
FAQs
Simple sitemap generation plugin for Docusaurus.
The npm package @docusaurus/plugin-sitemap receives a total of 202,766 weekly downloads. As such, @docusaurus/plugin-sitemap popularity was classified as popular.
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.
Package last updated on 17 Dec 2020
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.
Related posts
Security News
Linux Foundation Warns Open Source Developers: Compliance with Sanctions Is Not Optional
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
By Sarah Gooding - Feb 06, 2025
Security News
Maven Central Adds Sigstore Signature Validation
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.
By Sarah Gooding - Feb 06, 2025