https://github.com/nuxt-modules/sitemap
Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.
https://github.com/nuxt-modules/sitemap
Last synced: about 2 months ago
JSON representation
Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.
- Host: GitHub
- URL: https://github.com/nuxt-modules/sitemap
- Owner: nuxt-modules
- License: mit
- Created: 2022-12-12T16:40:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-14T15:39:36.000Z (7 months ago)
- Last Synced: 2025-08-15T18:24:32.519Z (7 months ago)
- Language: TypeScript
- Homepage: https://nuxtseo.com/sitemap
- Size: 4.11 MB
- Stars: 393
- Watchers: 3
- Forks: 45
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
@nuxtjs/sitemap
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
Nuxt Sitemap is a module for generating best-practice XML sitemaps that are consumed by the robots crawling your site.
New to XML sitemaps or SEO? Check out the [Controlling Web Crawlers](https://nuxtseo.com/learn/controlling-crawlers) guide to learn more about why you might
need these.
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](https://github.com/nuxt-modules/i18n) and [Nuxt Content](https://github.com/nuxt/content)
## Installation
💡 Using Nuxt 2? Use the [nuxt-community/sitemap-module](https://github.com/nuxt-community/sitemap-module) docs.
Install `@nuxtjs/sitemap` dependency to your project:
```bash
npx nuxi@latest module add sitemap
```
💡 Need a complete SEO solution for Nuxt? Check out [Nuxt SEO](https://nuxtseo.com).
## Documentation
[📖 Read the full documentation](https://nuxtseo.com/sitemap) for more information.
## Demos
- [Dynamic URLs](https://stackblitz.com/edit/nuxt-starter-dyraxc?file=server%2Fapi%2F_sitemap-urls.ts)
- [i18n](https://stackblitz.com/edit/nuxt-starter-jwuie4?file=app.vue)
- [Manual Chunking](https://stackblitz.com/edit/nuxt-starter-umyso3?file=nuxt.config.ts)
- [Nuxt Content Document Driven](https://stackblitz.com/edit/nuxt-starter-a5qk3s?file=nuxt.config.ts)
## Sponsors
## License
Licensed under the [MIT license](https://github.com/nuxt-modules/sitemap/blob/main/LICENSE.md).
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/sitemap/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxtjs/sitemap
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/sitemap.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/sitemap
[license-src]: https://img.shields.io/github/license/nuxt-modules/sitemap.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt-modules/sitemap/blob/main/LICENSE.md
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com