Skip to content

Latest commit

 

History

History

README.md

Webtools Sitemap add-on

Create a highly customizable sitemap XML in Strapi CMS.

Read the documentation

NPM Version Monthly download on NPM CI build status codecov.io

✨ Features

  • Multilingual (Implements rel="alternate" using the official i18n Strapi patterns)
  • Admin UI (Easily configure your sitemaps using the admin UI)
  • URL bundles (Bundle URLs by type and add them to the sitemap XML)
  • Custom URLs (URLs of pages which are not managed in Strapi)
  • Virtual sitemap (Sitemaps served from the database)
  • Cron regeneration (Automatically scheduled cron job for regeneration)
  • Sitemap indexes (Paginated sitemap indexes for large URL sets)
  • Exclude URLs (Exclude specified URLs from the sitemap)
  • CLI (CLI for sitemap generation)
  • Styled with XSL (Human readable XML styling)

⏳ Installation

Read the Getting Started tutorial or follow the steps below:

# using yarn
yarn add webtools-addon-sitemap

# using npm
npm install webtools-addon-sitemap --save

After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:

# using yarn
yarn build
yarn develop

# using npm
npm run build
npm run develop

The Sitemap plugin should now appear in the Webtools section of your Strapi app.

Enjoy 🎉

📓 Documentation

The full documentation of this plugin can be found on it's dedicated documentation website.

🔌 Addons

Webtools can be extended by installing addons that hook into the core Webtools functionality. Read more about how addons work and how to install them in the addons documentation.

🤝 Contributing

Feel free to fork and make a pull request of this plugin. All the input is welcome!

⭐️ Show your support

Give a star if this project helped you.

🔗 Links

🌎 Community support

📝 Resources