Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbaubree/vite-ssg-sitemap
https://github.com/jbaubree/vite-ssg-sitemap
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jbaubree/vite-ssg-sitemap
- Owner: jbaubree
- License: mit
- Created: 2022-03-02T12:25:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:18:27.000Z (about 2 months ago)
- Last Synced: 2024-08-01T17:48:41.343Z (about 2 months ago)
- Language: TypeScript
- Size: 1.65 MB
- Stars: 44
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vite - `vite-ssg-sitemap` - Sitemap generator (Pre-packed / Plugins)
README
# vite-ssg-sitemap
[](https://www.npmjs.com/package/vite-ssg-sitemap)
[](https://www.npmjs.com/package/vite-ssg-sitemap)
[](https://github.com/jbaubree/vite-ssg-sitemap/blob/main/src/types.ts)
[](https://github.com/jbaubree/vite-ssg-sitemap/blob/main/LICENSE)
[](https://github.com/jbaubree/vite-ssg-sitemap/actions/workflows/ci.yml)
> Sitemap generator working with vite-ssg using [sitemap-ts](https://github.com/jbaubree/sitemap-ts)
## Getting Started
### Vue
Install:
```bash
npm install -D vite-ssg
npm install -D vite-ssg-sitemap
```
### Vite config
Add to your `vite.config.js`:
```js
import generateSitemap from 'vite-ssg-sitemap'
export default {
plugins: [
Vue(),
],
ssgOptions: {
onFinished() { generateSitemap() },
},
}
```
Now, run `npm build` and this will generate sitemap.xml and robots.txt files on your dist folder.
### hostname
- **Type:** `string`
- **Default:** `'http://localhost/'`
Base URI.
### dynamicRoutes
- **Type:** `string[]`
- **Default:** `[]`
Array of strings with manual dynamic routes.
```js
export default {
plugins: [
Vue(),
],
ssgOptions: {
onFinished() {
const users = await api.get('/users')
const dynamicRoutes = users.map(user => `/users/${user.name}`)
generateSitemap({ dynamicRoutes })
},
},
}
```
### exclude
- **Type:** `string[]`
- **Default:** `[]`
Array of strings with excluded routes.
```js
export default {
plugins: [
Vue(),
],
ssgOptions: {
onFinished() {
generateSitemap({
exclude: ['/admin', '/private']
})
},
},
}
```
You can find a working example in example folder.
### externalSitemaps
- **Type:** `string[]`
- **Default:** `[]`
Array of strings with other sitemaps paths or urls.
```js
generateSitemap({
externalSitemaps: ['sitemap_1', 'sitemap_2', 'subpath/sitemap_3', 'https://site.com/sitemap.xml']
})
```
### outDir
- **Type:** `string`
- **Default:** `'dist'`
Output directory.
### extensions
- **Type:** `string | string[]`
- **Default:** `'html'`
File extensions that need to be generated.
Example: ['html', 'md']
### changefreq
- **Type:** `string | RoutesOptionMap`
- **Default:** `'daily'`
Change frequency option for sitemap.
### priority
- **Type:** `number | RoutesOptionMap`
- **Default:** `1`
Priority option for sitemap.
### lastmod
- **Type:** `Date | RoutesOptionMap`
- **Default:** `new Date()`
Last modification option for sitemap.
### RoutesOptionMap\
- **Type:** `{ [route: string]: Type }`
Used for changing `changefreq`, `priority`, or `lastmod` on a by-route level.
The (optional) route `'*'` is used as default.
### readable
- **Type:** `boolean`
- **Default:** `false`
Converts XML into a human readable format
### i18n
- **Type:** `{ defaultLanguage?: string, languages: string[], strategy?: 'suffix' | 'prefix' }`
- **Default:** `undefined, strategy: 'suffix'`
Add i18n support defining alternate links.
defaultLanguage will use this language with / and languages with /language.
strategy specifies if the language code is a suffix to the path or a prefix. 'suffix' is default. Example: http://localhost/mypage/en or http://localhost/en/mypage
### generateRobotsTxt
- **Type:** `boolean`
- **Default:** `true`
Enables robots.txt file generation
### robots
- **Type:** `RobotOption[]`
- **Default:** `[{ userAgent: '*', allow: '/' }]`
RobotOption:
- **userAgent**: `string`
- **allow**?: `string | string[]`
- **disallow**?: `string | string[]`
- **crawlDelay**?: `number`
- **cleanParam**?: `string`
## License
MIT License © 2022 [jbaubree](https://github.com/jbaubree)