72 lines
2.9 KiB
Markdown
72 lines
2.9 KiB
Markdown
<h1 align='center'>@nuxtjs/sitemap</h1>
|
|
|
|
<p align="center">
|
|
<a href='https://github.com/nuxt-modules/sitemap/actions/workflows/test.yml'>
|
|
</a>
|
|
<a href="https://www.npmjs.com/package/@nuxtjs/sitemap" target="__blank"><img src="https://img.shields.io/npm/v/@nuxtjs/sitemap?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
|
|
<a href="https://www.npmjs.com/package/@nuxtjs/sitemap" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@nuxtjs/sitemap?flat&colorA=002438&colorB=28CF8D"></a>
|
|
<a href="https://github.com/nuxt-modules/sitemap" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/nuxt-modules/sitemap?flat&colorA=002438&colorB=28CF8D"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt. Previously <i>nuxt-simple-sitemap</i>.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<table>
|
|
<tbody>
|
|
<td align="center">
|
|
<img width="800" height="0" /><br>
|
|
<i>Status:</i> <a href="https://github.com/nuxt-modules/sitemap/releases/tag/v6.0.0">v6 Released 🎉</a></b> <br>
|
|
<sup> Please report any issues 🐛</sup><br>
|
|
<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
|
|
<img width="800" height="0" />
|
|
</td>
|
|
</tbody>
|
|
</table>
|
|
</p>
|
|
|
|
## 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
|
|
|
|
💡 Need a complete SEO solution for Nuxt? Check out [Nuxt SEO](https://nuxtseo.com).
|
|
|
|
💡 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
|
|
```
|
|
|
|
# Documentation
|
|
|
|
[📖 Read the full documentation](https://nuxtseo.com/sitemap) for more information.
|
|
|
|
### StackBlitz Demos / Reproductions
|
|
|
|
- [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
|
|
|
|
<p align="center">
|
|
<a href="https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg">
|
|
<img src='https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg'/>
|
|
</a>
|
|
</p>
|
|
|
|
## License
|
|
|
|
MIT License © 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)
|