# vue-router-tiny-sitemap

> Minimum setup to generate a sitemap using Vue Router

Latest version **7.0.2** (published 2021-08-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-router-tiny-sitemap
pnpm add vue-router-tiny-sitemap
yarn add vue-router-tiny-sitemap
bun add vue-router-tiny-sitemap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.2 |
| Published | 2021-08-20 |
| First published | 2021-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | baim |
| Keywords | vue, vue-router, sitemap |

## Links

- npm: https://www.npmjs.com/package/vue-router-tiny-sitemap
- Repository: https://github.com/YosifG/Vue-Router-Tiny-Sitemap
- Homepage: https://github.com/YosifG/Vue-Router-Tiny-Sitemap#readme
- Issues: https://github.com/YosifG/Vue-Router-Tiny-Sitemap/issues
- npm.io page: https://npm.io/package/vue-router-tiny-sitemap

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 7.0.2 (latest) — 2021-08-20
- 7.0.1 — 2021-08-20
- 6.0.0 — 2021-08-19
- 5.0.0 — 2021-08-19
- 4.0.0 — 2021-08-19
- 3.0.0 — 2021-08-19
- 2.0.0 — 2021-08-19
- 1.0.0 — 2021-08-19

## README

# Vue-Router-Tiny-Sitemap
A hassle-free way to generate a sitemap.xml for your Vue Single Page Application.

## Installation
```

npm i vue-router-tiny-sitemap

```

## Prerequisites:

In order to use this package, you will need to have ['xmlbuilder2'](https://github.com/oozcitak/xmlbuilder2) as well as ['file-saver'](https://www.npmjs.com/package/file-saver) installed. 

## Example usage
Vue router tiny sitemap takes your routes and the base url of your website, constructs a sitemap.xml file and automatically starts a download for it. This process takes place in your browser. 
For esample, you would have to start your server with "npm run serve", then visit the localhost URL. This will then automatically commence the sitemap.xml download, and output a success message in the console.

```javascript
// src/router.js
const routes = [
    //your Vue-router routes array
]

var generateSitemap = require("vue-router-tiny-sitemap")
generateSitemap(routes, "baseURL.com")

---
_Source: https://npm.io/package/vue-router-tiny-sitemap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._