Security News
Supply Chain Attack Detected in Solana's web3.js Library
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
By Sarah Gooding - Dec 03, 2024
Huge News!Announcing our $40M Series B led by Abstract Ventures.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.59 (2020-07-24)
:rocket: New Feature
docusaurus-migrate,docusaurus-plugin-client-redirects- #3015 feat: automate migration from v1 to v2 (@anshulrgoyal)
docusaurus-initdocusaurus-theme-search-algolia- #2815 feat(v2): introduce DocSearch v3 search (@francoischalifour)
docusaurus-init,docusaurus-types,docusaurusdocusaurus-plugin-content-docs,docusaurus-utilsdocusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs- #3069 feat(v2): support for adding relative images and handling broken image links (@anshulrgoyal)
docusaurus-init,docusaurus-module-type-aliases,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-debug,docusaurus-theme-classic,docusaurus-types,docusaurusdocusaurus-init,docusaurus- #3080 feat(v2): add support for serve command (@anshulrgoyal)
docusaurus-module-type-aliases,docusaurus-plugin-debug,docusaurus-types,docusaurusdocusaurusdocusaurus-module-type-aliases,docusaurus-plugin-debug,docusaurus- #3050 feat(v2): Collect plugin versions to allow them to be inspected in debug plugin (@SamChou19815)
docusaurus-theme-classic- #3038 feat(v2): Support keywords meta in blog posts (@dpkg)
- #2974 feat(v2): Error when hooks depends on context is used outside of Layout (@SamChou19815)
docusaurus-plugin-pwa,docusaurus- #2205 feat(v2): Plugin for Offline/PWA support (@codemonkey800)
docusaurus-plugin-ideal-image,docusaurus-types,docusaurusdocusaurus-plugin-content-docsdocusaurus-1.xdocusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus-types,docusaurus- #2943 feat(v2): option and config validation life cycle method for official plugins (@anshulrgoyal)
:boom: Breaking Change
docusaurus-init,docusaurus-module-type-aliases,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-debug,docusaurus-theme-classic,docusaurus-types,docusaurusdocusaurus-theme-classic,docusaurus
:bug: Bug Fix
docusaurusdocusaurus-theme-classicdocusaurus-plugin-content-docsdocusaurus-plugin-content-pages- #3025 fix(v2):pass siteConfig as prop to pages (@anshulrgoyal)
docusaurus-init- #3008 chore(v2): Add E2E test for yarn v2 (@SamChou19815)
- Other
docusaurus-theme-classic,docusaurusdocusaurus-plugin-content-docs,docusaurus-utils,docusaurusdocusaurus-plugin-client-redirects,docusaurus-utils,docusaurusdocusaurus-1.x- #2993 fix(relative path): last update date and by isn’t generated if localh… (@amirulahmad)
docusaurus-plugin-client-redirects- #2969 fix: fromExtensions and toExtensions translation when used with baseUrl (@jknoxville)
:nail_care: Polish
docusaurus-theme-classic,docusaurusdocusaurus-mdx-loaderdocusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-plugin-sitemap,docusaurus-theme-live-codeblock,docusaurus-typesdocusaurus- #2987 chore(v2): use joi for config validation (@anshulrgoyal)
:memo: Documentation
- #3026 docs(v2): add documentation for migration command (@teikjun)
- #3094 docs(v2): showcase user Clutch (@danielhochman)
- #3101 docs(v2):Add azure-pipelines CI guide (@ayan-b)
- #3098 docs: Add azure-pipelines CI guide (@ayan-b)
- #3086 doc(v2): replace heading position (@eKhattak)
- #3082 fixing few typos and enhancing few sentences clarity (@aladin002dz)
- #3078 Updated link for #docusaurus-2-dev discord (@jordanliu)
- #3076 docs(v2): showcase Runlet (@vandreleal)
- #3040 docs(v2): correct the documentation for docs-only mode (@teikjun)
- #3034 docs(v2): showcase user Tasit (@pcowgill)
- #3022 docs(v2): showcase Eta (@nebrelbug)
- #3011 docs(v1): external links (@slorber)
- #2997 docs(v2): Document TypeScript support (@SamChou19815)
- #2973 docs(v2): Fix typo in markdown-features (@ehsanjso)
- #2991 Showcase Amphora Data (@xtellurian)
- #2983 docs(v2): add plugin redirects production build note (@slorber)
- #2967 docs(v2): fix typos in plugin-content examples (@hi-matbub)
- #2960 doc(v2): publish doc update after alpha.58 release (@slorber)
- #2966 docs(v2): fix typo in plugin-content-pages example (@hi-matbub)
:house: Internal
docusaurus-migrate- Other
docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurusdocusaurus-mdx-loaderdocusaurus-plugin-pwa,docusaurus- #3055 chore(v2): Adopt corejs 3 and only import at entry point (@SamChou19815)
docusaurus-init,docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-plugin-debug,docusaurus-plugin-ideal-image,docusaurus-plugin-sitemap,docusaurus-theme-classic,docusaurus-utils,docusaurusdocusaurus-init- #3008 chore(v2): Add E2E test for yarn v2 (@SamChou19815)
docusaurus-plugin-content-docs,docusaurus-utils,docusaurusdocusaurus- #3007 fix(v2): Add two missing docusaurus core babel dependency (@SamChou19815)
- #2987 chore(v2): use joi for config validation (@anshulrgoyal)
- #2950 chore(v2): Implement a simple E2E testing mechanism for
docusausus start(@SamChou19815)
docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-plugin-sitemap,docusaurus-theme-live-codeblock,docusaurus-typesdocusaurus-theme-classic- #2996 chore(v2): Merge devDependencies in theme-classic (@SamChou19815)
- #2977 chore(v2): Remove extraneous package-lock.json (@SamChou19815)
docusaurus-plugin-client-redirects- #2962 Feat: replace yup with joi for cleaner validation (@anshulrgoyal)
docusaurus-init,docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-plugin-sitemap,docusaurus-theme-bootstrap,docusaurus-theme-classic,docusaurus-theme-search-algolia,docusaurus-types,docusaurus-utils,docusaurus,lqip-loader- #2976 chore(v2): Fix more eslint errors (@SamChou19815)
docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-sitemap,docusaurus-utils,docusaurus,lqip-loader- #2972 chore(v2): Fix a lot of eslint warnings (@SamChou19815)
Committers: 25
- Alexey Pyltsyn (@lex111)
- Amirul Ahmad (@amirulahmad)
- Anshul Goyal (@anshulrgoyal)
- Arsalan Khattak (@eKhattak)
- Ayan Banerjee (@ayan-b)
- Ben Gubler (@nebrelbug)
- Daniel Hochman (@danielhochman)
- Deepak Giri (@dpkg)
- Eric Dobbertin (@aldeed)
- François Chalifour (@francoischalifour)
- Frida Hjelm (@svtfrida)
- Jeremy Asuncion (@codemonkey800)
- John Knox (@jknoxville)
- Jordan Liu (@jordanliu)
- Mahfoudh Arous (@aladin002dz)
- Paul Cowgill (@pcowgill)
- Rian Finnegan (@xtellurian)
- Sam Zhou (@SamChou19815)
- Sébastien Lorber (@slorber)
- Taylor Allen (@taylorallen0913)
- Teik Jun (@teikjun)
- Vandré Leal (@vandreleal)
- Yangshun Tay (@yangshun)
- ehsan jso (@ehsanjso)
- matbub (@hi-matbub)
FAQs
Simple sitemap generation plugin for Docusaurus.
The npm package @docusaurus/plugin-sitemap receives a total of 250,614 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 10 Apr 2019
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
Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
By Socket Research Team - Dec 02, 2024
Security News
Research
Typosquatting Cryptographic Libraries: Malicious npm Packages Threaten Crypto Developers with Keylogging and Wallet Theft
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
By Kirill Boychenko - Nov 27, 2024