Sitemap Module for Nuxt 2

Sitemap Module for Nuxt 2 is an open-source Nuxt module that automatically generates or serves a dynamic sitemap.xml file for Nuxt 2 projects, maintained by the Nuxt community.

What is Sitemap Module for Nuxt 2?

Sitemap Module for Nuxt 2 is an npm package published as @nuxtjs/sitemap, built to add XML sitemap capabilities to Nuxt 2 applications. It accepts your Nuxt application's routes and outputs a sitemap.xml file that follows the Sitemaps protocol. The module can generate the sitemap at build time or serve it dynamically at runtime. It is authored by Nicolas Pennec and Pooya Parsa and is released under the MIT License, with documentation hosted at sitemap.nuxtjs.org.

Key Features

• Automatic sitemap generation — Creates sitemap.xml from your Nuxt 2 project's routes automatically, removing the need to hand-write XML.
• Dynamic serving — Optionally serves sitemap.xml on the fly, so route updates are reflected without a rebuild.
• Explicit Nuxt 2 targeting — The 2.x line of the module is dedicated to Nuxt 2 users; Nuxt 3 users are directed to the separate nuxt-modules/sitemap repository.
• MIT licensed open source — Free to use and modify, with contribution history visible on GitHub.
• Dedicated documentation portal — Full installation and usage instructions are available at sitemap.nuxtjs.org.

Who is it for?

• Nuxt 2 developers who need a standard sitemap.xml for search engine indexing.
• SEO specialists who want automated sitemap generation instead of manually maintaining XML files.
• Site operators using Nuxt 2 with server-side rendering who need sitemap URLs to stay current with content changes.

What can you do with Sitemap Module for Nuxt 2?

• Nuxt 2 site owners: Generate a sitemap.xml to submit to Google Search Console and Bing Webmaster Tools.
• SSR applications: Serve a dynamic sitemap that reflects the latest routes without rebuilding.
• Developers: Set up the module quickly by following the official documentation and release notes on the GitHub repository.

FAQ

Is Sitemap Module for Nuxt 2 free?

Yes, the module is open source under the MIT License, meaning it is free to use in both personal and commercial projects.

Does Sitemap Module for Nuxt 2 work with Nuxt 3?

No. The 2.x version is explicitly for Nuxt 2. If you are using Nuxt 3, the project has moved to the nuxt-modules/sitemap repository.

How do I install Sitemap Module for Nuxt 2?

The package is available on npm as @nuxtjs/sitemap. The readme links to sitemap.nuxtjs.org for detailed setup instructions.

What does Sitemap Module output?

It outputs a sitemap.xml file conforming to the Sitemaps protocol defined at sitemaps.org/protocol.html, containing the routes of your Nuxt 2 app.