@nuxtjs/sitemap

Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt. Previously nuxt-simple-sitemap.

Status: v5 Released 🎉 Please report any issues 🐛 Made possible by my Sponsor Program 💖 Follow me @harlan_zw 🐦 • Join Discord for help

Features

• 🌴 Single /sitemap.xml or multiple /posts-sitemap.xml, /pages-sitemap.xml
• 📊 Fetch your sitemap URLs from anywhere
• 😌 Automatic lastmod, image discovery and best practice sitemaps
• 🔄 SWR caching, route rules support
• 🎨 Debug using the Nuxt DevTools integration or the XML Stylesheet
• 🤝 Integrates seamlessly with Nuxt I18n and Nuxt Content

Installation

💡 Need a complete SEO solution for Nuxt? Check out Nuxt SEO.

💡 Using Nuxt 2? Use the nuxt-community/sitemap-module docs.

1. Install @nuxtjs/sitemap dependency to your project:

pnpm add -D @nuxtjs/sitemap
#
yarn add -D @nuxtjs/sitemap
#
npm install -D @nuxtjs/sitemap

2. Add it to your modules section in your nuxt.config:

export default defineNuxtConfig({
  modules: ['@nuxtjs/sitemap']
})

Documentation

📖 Read the full documentation for more information.

StackBlitz Demos / Reproductions

• Dynamic URLs
• i18n
• Manual Chunking
• Nuxt Content Document Driven

Sponsors

License

MIT License © 2022-PRESENT Harlan Wilton