react-static-plugin-sitemap

A React-Static plugin for exporting sitemap information.

Installation

In an existing react-static site run:

``bash
$ yarn add react-static-plugin-sitemap
`

Then add the plugin to your static.config.js:

`javascript
export default {
plugins: ['react-static-plugin-sitemap'],
}
`

Usage

- A config.siteRoot is required for this plugin to work properly, since sitemap's are required to use full
- Each route in your site will createt a item in the sitemap
- By default, the url's tag will be set to the prefixed path of each route.
- All property/value pairs under a route's sitemap object will be used as xml tags for that route, eg.

`javascript
export default {
siteRoot: 'https://hello.com'
}
const routes = [
{
path: '/blog/post/1',
sitemap: {
hreflang: [
{language:'x-default', url: '/blog/post/1'},
{language:'en', url: '/blog/post/1'},
{language:'de-DE', url: '/de/blog/post/1'},
],
lastmod: '10/10/2010',
priority: 0.5,
'image:image': {
'image:loc': https://raw.githubusercontent.com/react-static/react-static/master/media/react-static-logo-2x.png,
'image:caption': 'React Static',
},
},
},
{
path: '/blog/draft/2',
sitemap: {
noindex: true // Excludes route from sitemap.xml
},
},
]
`

Would result in the following XML:

`xml



https://hello.com/blog/post/1/
10/10/2010
0.5

https://raw.githubusercontent.com/react-static/react-static/master/media/react-static-logo-2x.png
React Static






`

With Options

`javascript
export default {
plugins: [
[
'react-static-plugin-sitemap',
{
getAttributes: route => ({
customXmlAttribute: route.customProperty,
}),

// Given a route where route.customProperty === 40,
// This would create a
// in that routes tag
},
],
],
}
``