The SiteMapPlugin generates a sitemap using the pages in the Mosaic filesystem that adheres to the sitemaps XML schema.

The output of the plugin is a file is named /sitemap.xml.

This plugin runs with no special priority.

PropertyDescription
siteUrlThe site URL. Used as the prefix for loc entries in the sitemap as these must start with a protocol

This plugin is included in the mosaic config shipped by the Mosaic standard generator. So if you use the below import in your mosaic.config.mjs file then the plugin is included already:

To add it yourself, add the following to the plugins collection:

To visualise your sitemap you can combine this plugin with the Sitemap component provided by @jpmorganchase/mosaic-sitemap-component.

Rendering the Sitemap component will render a tree view of your sitemap.

Have a look at this site's pages, here.

Mosaic BETA

Coming soon