{"id":22773,"library":"vite-plugin-pages-sitemap","title":"vite-plugin-pages-sitemap","description":"Sitemap generator plugin for Vite that integrates with vite-plugin-pages to automatically generate sitemaps from file-based routing. Version 1.7.1 is the current stable release. The plugin is actively maintained. Key differentiators: it leverages the routes generated by vite-plugin-pages, supports dynamic routes, i18n with alternate links, custom hostname, exclusion patterns, and configuration for changefreq, priority, lastmod, and readable XML output. It also integrates with Nuxt.js style route naming and can generate a robots.txt. Alternative to generic sitemap generators when using vite-plugin-pages.","status":"active","version":"1.7.1","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","typescript"],"install":[{"cmd":"npm install vite-plugin-pages-sitemap","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-pages-sitemap","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-pages-sitemap","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency; routes must be generated by vite-plugin-pages","package":"vite-plugin-pages","optional":false}],"imports":[{"note":"Default export. The package is ESM-only since v1.0, so use import syntax.","wrong":"const generateSitemap = require('vite-plugin-pages-sitemap')","symbol":"generateSitemap","correct":"import generateSitemap from 'vite-plugin-pages-sitemap'"}],"quickstart":{"code":"import Pages from 'vite-plugin-pages';\nimport generateSitemap from 'vite-plugin-pages-sitemap';\n\nexport default {\n  plugins: [\n    Pages({\n      onRoutesGenerated: (routes) => {\n        generateSitemap({ routes, hostname: 'https://example.com' });\n      },\n    }),\n  ],\n};","lang":"typescript","description":"Basic setup integrating vite-plugin-pages and generating a sitemap on routes generation."},"warnings":[{"fix":"Update to >=1.0.0 and adjust config to use new API: pass options to generateSitemap directly.","message":"Prior to v1.0, the plugin used a different configuration API. Upgrade required.","severity":"breaking","affected_versions":"<1.0.0"},{"fix":"Use onRoutesGenerated hook as shown in quickstart.","message":"Passing routes as a separate option is deprecated; use the onRoutesGenerated callback instead.","severity":"deprecated","affected_versions":">=1.0.0 <1.5.0"},{"fix":"Ensure vite-plugin-pages is installed: npm install -D vite-plugin-pages","message":"The plugin requires vite-plugin-pages as a peer dependency; must be installed separately.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Manually add dynamic routes to the routes array as shown in README.","message":"Dynamic routes must be passed as part of the routes array in generateSitemap options; not automatically detected.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Pass hostname option with production URL.","message":"The hostname option defaults to 'http://localhost/'; forgetting to set it for production will result in incorrect sitemap URLs.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run npm install -D vite-plugin-pages-sitemap","cause":"Package not installed or module resolution issue.","error":"Cannot find module 'vite-plugin-pages-sitemap'"},{"fix":"Use import generateSitemap from 'vite-plugin-pages-sitemap';","cause":"Import incorrectly as named import instead of default.","error":"TypeError: generateSitemap is not a function"},{"fix":"Ensure you pass routes option with an array of route objects or strings.","cause":"Routes not provided or undefined.","error":"Error: Cannot read property 'route' of undefined"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}