strapi-plugin-sitemap

Strapi Plugin Sitemap

This plugin is an integration of the UID field type. In Strapi you can manage your URLs by adding UID fields to your single or collection types. This field will act as a wrapper for the title field and will generate a unique SEO friendly path for each instance of the type. This plugin will then use those paths to generate a fully customizable sitemap for all your URLs.

Installation

Use npm or yarn to install and build the plugin.

yarn add strapi-plugin-sitemap
yarn build
yarn develop

Configuration

Before you can generate the sitemap you need to specify what you want to be in it. In the admin section of the plugin you can add 'Collection entries' and 'Custom entries' to the sitemap. With collection entries you can add all URLs of a collection or single type, with custom entries you can add URLs which are not managed by Strapi. Also make sure to set the hostname of your website.

After saving the settings and generating the sitemap, it will be written in the /public folder of your Strapi project, making it available at http://localhost:1337/sitemap.xml.

Optional (but recommended)

1. Add the sitemap.xml to the .gitignore of your project.

2. Make sure the sitemap is always up-to-date. You can either add a cron job, or create a lifecycle method to run the createSitemap() service.

Cron job example

// Generate the sitemap every 12 hours
'0 */12 * * *': () => {
    strapi.plugins.sitemap.services.sitemap.createSitemap();
},

Resources

• MIT License

Links

• NPM package
• GitHub repository

⭐️ Show your support

Give a star if this project helped you.