@gammastream/scully-plugin-sitemap

scully-plugin-sitemap

This postRenderer plugin for Scully that will generate a sitemap.xml for the generated routes.

Installation

To install this library with npm run

$ npm install @gammastream/scully-plugin-sitemap --save-dev

Usage

Add the plugin to the defaultPostRenderers to execute it on all rendered pages:

const {RouteTypes} = require('@scullyio/scully');
const {Sitemap} = require('@gammastream/scully-plugin-sitemap');

const defaultPostRenderers = [Sitemap];

const sitemapOptions = {
  urlPrefix: 'https://gamma.stream',
  sitemapFilename: 'sitemap.xml',
  changeFreq: 'monthly',
  priority: ['1.0', '0.9', '0.8', '0.7', '0.6', '0.5', '0.4', '0.3', '0.2', '0.1', '0.0'],
  ignoredRoutes: ['/404']
};


exports.config = {
  projectRoot: './src/app',
  sitemapOptions,
  defaultPostRenderers,
  routes: {}
};

Build app and run scully like normal.

npm run build
npm run scully

Configuring Priority

The priority of a route can be configured by setting the priority level based on the number of segments in a given route.

[
	'1.0', // `/` - [ '' ] (1 segment)
	'0.9', // `/services` - [ '', 'services' ] (2 segments)
	'0.8', // `/services/hosting` - [ '', 'services', 'hosting' ]
	// etc...
]

Notes

• Currently, the default priority (0.5) is assigned to all routes. Planned for a future update is the ability to assign a priority based on the number of segments in a route. (Completed in v0.0.4)

• Sitemap is regenerated with every route. At some time in the future, we expect Scully to support a class of plugins that run after it is finished generating all the routes.

Questions or Issues

If you have any issues you can raise them here or contact me at: GammaStream