blankogmbh/kirby-sitemap

Kirby sitemap.xml Plugin

This plugin generates a sitemap.xml from all pages in Kirby. It's possible to exclude pages from the sitemap and to assign which pages should have the highest priority (1). The priority can be disabled for all pages otherwise pages are prioritized automaticaly by depth., _(*1)

Installation

Composer

composer require blankogmbh/kirby-sitemap, _(*2)

Kirby CLI

kirby plugin:install blankogmbh/kirby-sitemap, _(*3)

Git

Check out this repository to to /site/plugins/ or include it as a submodule git submodule add https://github.com/blankogmbh/kirby-sitemap.git site/plugins/kirby-sitemap., _(*4)

Usage

You can preview your sitemap by browsing to http://your-fancy-kirby-site.net/sitemap.xml., _(*5)

The plugin can be configured via Kirby’s config.php., _(*6)

Exclude Pages From the Sitemap

c::set('sitemap.exclude', [
    'error', // just the page error
    'example*', // exclude all pages starting with example
    'example/*', // exclude only subpages of example (but include example)
]);

Exclude hidden Pages

c::set('sitemap.excludeHiddenPages', true);

Include hidden pages on root level

If you set sitemap.excludeHiddenPages to true, but want the hidden root pages to be included, _(*7)

c::set('sitemap.includeHiddenRootPages', true);

Prioritize Pages

c::set('sitemap.priority', [
    'contact', // just the page contact
    'important*', // all pages starting with important
    'important/*', // all subpages of important (but not important)
]);

c::set('sitemap.priority', false); // disable prioritization

Ping Google on page create, delete, sort, hide, move

c::set('sitemap.pingGoogle', true);

Change route pattern

c::set('sitemap.route.pattern', 'sitemap-xml');

Author

Markus Denhoff / Blanko denhoff@blanko.de, _(*8)

Inspired by Thomas Ghysels sitemap plugin., _(*9)