https://github.com/jonaskuske/parcel-plugin-sitemap-exclude
🛠[deprecated] A very basic parcel plugin for creating site maps
https://github.com/jonaskuske/parcel-plugin-sitemap-exclude
Last synced: 11 months ago
JSON representation
🛠[deprecated] A very basic parcel plugin for creating site maps
- Host: GitHub
- URL: https://github.com/jonaskuske/parcel-plugin-sitemap-exclude
- Owner: jonaskuske
- License: mit
- Created: 2018-12-03T18:21:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-03T18:21:55.000Z (over 7 years ago)
- Last Synced: 2025-03-29T23:17:58.545Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Deprecated] Parcel Sitemap Plugin (with `exclude` option)
> âš This package is deprecated as its functionality has been merged into [parcel-plugin-sitemap@2.0.0](https://www.npmjs.com/package/parcel-plugin-sitemap)!
Fork of [parcel-plugin-sitemap](https://github.com/parcel-bundler/parcel), a plugin for creating (very) basic sitemaps.
Added the functionality to exclude HTML files from being added to the sitemap by specifying globs in the respective package.json field.
The glob(s) will be negated and passed to [fast-glob](https://www.npmjs.com/package/fast-glob) under the hood.
```json
"sitemap": {
"siteURL": "https://www.example.org/",
"exclude": "static/**/*"
}
```
or an Array of globs:
```json
"sitemap": {
"siteURL": "https://www.example.org/",
"exclude": [
"static/**/*",
"exclude.html"
]
}
```
### Disclaimer:
This plugin will not create a fully featured [sitemap](https://www.sitemaps.org/protocol.html), but the most basic one, that is still valid. Parcel makes it easy for you to create a sitemap manually, as html files keep their names while beeing processed. So if you want to achive perfect SEO optimization you should not use this plugin but create a sidemap manually.
**However**, if you just want to make sure all pages are listed so that search engines can crawl them, this plugin has you covered.
## Installation
```bash
yarn add parcel-plugin-sitemap-exclude
```
or
```bash
npm install parcel-plugin-sitemap-exclude
```
## Usage
Add the following snippet to your `package.json` file and replace "https://www.example.org/" with the location where your site will be hosted:
```json
"sitemap": {
"siteURL": "https://www.example.org/"
}
```
## License
MIT License