Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad/docpad-plugin-sitemap

Auto-generated sitemaps for DocPad
https://github.com/docpad/docpad-plugin-sitemap

docpad-plugin

Last synced: 2 months ago
JSON representation

Auto-generated sitemaps for DocPad

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-sitemap
Owner: docpad
License: other
Created: 2013-07-29T20:37:07.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2024-01-07T08:18:20.000Z (almost 1 year ago)
Last Synced: 2024-09-21T14:36:55.710Z (4 months ago)
Topics: docpad-plugin
Language: CoffeeScript
Size: 223 KB
Stars: 10
Watchers: 16
Forks: 10
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

Sitemap Plugin for DocPad

This DocPad plugin will automatically generate a valid `sitemap.xml` file for search engines. It's merely a wrapper for the [sitemap.js](https://github.com/ekalinin/sitemap.js) library.

This project was forked from the solid start made by [Khalid Jebbari](https://github.com/DjebbZ/docpad-plugin-sitemap).

To learn more about sitemap.xml files, read [the protocol](http://www.sitemaps.org/).

## Usage

For each document, you can specify the following metadata:

``` coffee
changefreq: 'always' || 'hourly' || 'daily' || 'weekly' || 'monthly' || 'yearly' || 'never' # Change frequency, defaults to 'weekly'
priority: 0.5 # value between 0.0 and 1.0, defaults to 0.5
sitemap: true || false # defaults to true, if false no entry for this document will be generated
```

For the whole site you can set defaults using the plugin configuration in your docpad.cson or docpad.coffee file.

``` coffee
templateData:
site:
url: "http://your-website-production-url.com" # required for sitemap

plugins:
sitemap:
cachetime: 600000
changefreq: 'weekly'
priority: 0.5
filePath: 'sitemap.xml'
```

By default all HTML files on your site will be considered for inclusion. To specify a different collection, change the `collectionName` plugin configuration option like so:

``` coffee
plugins:
sitemap:
collectionName: 'someCollectionName'
```