{"_id":"@axelrindle/vite-plugin-sitemap","name":"@axelrindle/vite-plugin-sitemap","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@axelrindle/vite-plugin-sitemap","version":"0.1.0","description":"Vite plugin for dynamic sitemap generation.","private":false,"exports":{".":{"import":"./dist/index.mjs","require":"./dist/index.cjs","types":"./dist/index.d.ts"}},"main":"dist/index.cjs","module":"dist/index.mjs","types":"dist/index.d.ts","scripts":{"test":"vitest","build":"unbuild","prepack":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/axelrindle/vite-plugin-sitemap.git"},"keywords":["vite","vite-plugin","sitemap","sitemap-generator"],"author":{"name":"Axel Rindle","email":"mail@axelrindle.de"},"license":"MIT","bugs":{"url":"https://github.com/axelrindle/vite-plugin-sitemap/issues"},"homepage":"https://github.com/axelrindle/vite-plugin-sitemap#readme","devDependencies":{"@commitlint/cli":"^17.5.1","@commitlint/config-conventional":"^17.4.4","@types/node":"^18.15.11","husky":"^8.0.3","unbuild":"^1.2.0","vite":"^4.0.0","vitest":"^0.29.8"},"dependencies":{"chalk":"^5.2.0","mkdirp":"^2.1.6","xml-js":"^1.6.11"},"engines":{"node":">=16"},"gitHead":"a35d7856fab16c11f1e09674f8528aa1125488fd","_id":"@axelrindle/vite-plugin-sitemap@0.1.0","_nodeVersion":"18.13.0","_npmVersion":"9.3.0","dist":{"integrity":"sha512-x+570nt5q2f0gxaMWWM1KsXbBSECw7YpF927f0OLgjWa8GepaRjfDLzkakQb/CpC8Ua28BnVwxuhSAOGFfq55Q==","shasum":"d443414d9c878afe5ec57a743d2cacb697334263","tarball":"https://registry.npmjs.org/@axelrindle/vite-plugin-sitemap/-/vite-plugin-sitemap-0.1.0.tgz","fileCount":6,"unpackedSize":8912,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGc0rNHuJ6pjO+/PTLuG5R/6pqnBSlBONcV824QyqWBOAiEA/asLCWILz0JtiOvHRjhwpVgtinBCwhB0JHt07ZgnrUE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkKUYOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq1gQ/+OzmKOVcVtumWtdPP6prvUTAXqh+ukVdhE8LmHn3hTKdKJQ+C\r\nQZQtMTsB1mTpTm2/sPNWPyZAArRnmRSHJm61/xcok0LaBGBrUqKqNaxPQmVs\r\nNUjMMn/MvCygS22yoqICYPOMK9kodmyggr/NOdZEvjqJNPtMLhbDD8Ss6zBP\r\nwLV56QyECbrpSpy8X7z5ycYcXskfpLKDVVZc2ZKQ/16Hcrfpz3JSRBAjedKH\r\nyteVXoN3c2c1RJS2u7d+oIiXFCOsYNg/cWow/eyuwehGXIy5pCHB03aEj4tF\r\n2tlUMqmYPXv3RePsABNyvKeaVmPOveqI7sCnOr/efTUJm0SC99QsWf2eR2Nt\r\nfn5tVmkZ7k/aYcX/z+uk4xRTO4/ZswXbOoBOo0zWyaqFyuB2eZMOj/Cj+U2O\r\n7ImJIVjg6eZdq1ua3kxiLDsue/LXhhY+NeNqMRfcJEfA9D1TrLgLfdR9s4gl\r\nkSAD8X8sFeu/IzwaYec72Jp3YdfmYZnhlqGLqPTZpbrulF2l3WQIyJcFSJ8I\r\nGWkjg5pQLKvyKZ5tTNhowZSaDAhyrSCsdFsdKRK8shICkG9rQ2ul4+OcgpGD\r\n1cCx6+AcyNhQajfsoc49PiuCn8hP92VC4PTnnCJqeaoltnbse9hiCBuM8+w9\r\n6h44FGcnL7zX35aNHxUDK6cdtxW5jB9Q8oo=\r\n=8NyS\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"axelrindle","email":"mail@axelrindle.de"},"directories":{},"maintainers":[{"name":"axelrindle","email":"mail@axelrindle.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/vite-plugin-sitemap_0.1.0_1680426510127_0.3577669195104318"},"_hasShrinkwrap":false}},"time":{"created":"2023-04-02T09:08:30.042Z","0.1.0":"2023-04-02T09:08:30.324Z","modified":"2023-04-02T09:08:30.510Z"},"maintainers":[{"name":"axelrindle","email":"mail@axelrindle.de"}],"description":"Vite plugin for dynamic sitemap generation.","homepage":"https://github.com/axelrindle/vite-plugin-sitemap#readme","keywords":["vite","vite-plugin","sitemap","sitemap-generator"],"repository":{"type":"git","url":"git+https://github.com/axelrindle/vite-plugin-sitemap.git"},"author":{"name":"Axel Rindle","email":"mail@axelrindle.de"},"bugs":{"url":"https://github.com/axelrindle/vite-plugin-sitemap/issues"},"license":"MIT","readme":"[![CI](https://github.com/axelrindle/vite-plugin-sitemap/actions/workflows/ci.yml/badge.svg)](https://github.com/axelrindle/vite-plugin-sitemap/actions/workflows/ci.yml)\n![npm (scoped)](https://img.shields.io/npm/v/@axelrindle/vite-plugin-sitemap)\n[![commit style](https://img.shields.io/badge/Commits-Conventional-fa6673?logo=conventional-commits)](https://www.conventionalcommits.org/en/v1.0.0/)\n[![changelog style](https://img.shields.io/badge/Keep%20a-Changelog-e05735?logo=keep-a-changelog)](https://keepachangelog.com/en/1.1.0/)\n\n# vite-plugin-sitemap\n\n> 🗺 Generate a sitemap\n\nGenerated sitemaps adhere to the protocol [described on sitemaps.org](https://www.sitemaps.org/protocol.html).\n\n## Install\n\n```\nnpm i @axelrindle/vite-plugin-sitemap\n```\n\n## Usage\n\n```js\nimport sitemap from '@axelrindle/vite-plugin-sitemap'\nimport { defineConfig } from 'vite'\n\nexport default defineConfig({\n    plugins: [\n        sitemap()\n    ]\n})\n```\n\n## Configuration\n\nThe `sitemap` function accepts an object with the following options:\n\n### `pages`\n\nAn array of `Page` objects describing the basic structure you want your\nsitemap to represent.\n\nA `Page` has the following structure:\n\n```ts\ninterface Page {\n    // ------------------------------------\n    // the relative path to the source file\n    // this can be any type of file\n    file: string\n\n    // ------------------------------------\n    // the relative url where the page\n    // is accessible within your website\n    route: string\n\n    // ------------------------------------\n    // a value between 0.0 and 1.0\n    // defaults to 0.5\n    priority?: number\n}\n```\n\n### `output`\n\nThe output directory to place the sitemap in.\n\nDefaults to `public`.\n\n### `baseUrl`\n\nA base url to prefix all pages with.\n\n## TODO\n\n- Automatic loading & processing of `react-router` route definitions\n\n## License\n\n[MIT](LICENSE)\n","readmeFilename":"README.md"}