PHPackages schnti/sitemap - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. schnti/sitemap ActiveKirby-plugin[Utility & Helpers](/categories/utility) schnti/sitemap ============== kirby sitemap plugin 2.1.1(1y ago)61.6k1MITPHP Since Apr 14Pushed 1y ago1 watchersCompare [ Source](https://github.com/schnti/kirby-sitemap)[ Packagist](https://packagist.org/packages/schnti/sitemap)[ Docs](https://github.com/schnti/kirby-sitemap)[ RSS](/packages/schnti-sitemap/feed)WikiDiscussions master Synced 2d ago READMEChangelog (2)Dependencies (1)Versions (8)Used By (1) (simple) Sitemap Plugin ======================= [](#simple-sitemap-plugin) A plugin for [Kirby CMS](http://getkirby.com) that generates an `sitemap.xml` and HTML sitemap. > ⚠️ Warning: there are config breaking changes between version 1. \* and 2. \* Commercial Usage ---------------- [](#commercial-usage) This plugin is free but if you use it in a commercial project please consider - [making a donation](https://www.paypal.me/schnti/5) Installation ------------ [](#installation) ### Download [](#download) [Download the files](https://github.com/schnti/kirby-sitemap/archive/master.zip) and place them inside `site/plugins/sitemap`. ### Composer [](#composer) ``` composer require schnti/sitemap ``` ### Git Submodule [](#git-submodule) You can add the plugin as a Git submodule. ``` $ cd your/project/root $ git submodule add https://github.com/schnti/-sitemap.git site/plugins/sitemap $ git submodule update --init --recursive $ git commit -am "Add Kirby Sitemap plugin" ``` Run these commands to update the plugin: ``` $ cd your/project/root $ git submodule foreach git checkout master $ git submodule foreach git pull $ git commit -am "Update submodules" $ git submodule update --init --recursive ``` Options ------- [](#options) Config options -------------- [](#config-options) You can set the following default options in your `config.php`: ``` 'schnti.sitemap.xml.sites.blacklist' => ['error', 'sitemap', 'thankyou'], 'schnti.sitemap.xml.sites.whitelist' => ['home', 'impressum', 'datenschutzerklaerung'], 'schnti.sitemap.xml.sites.prio' => [], 'schnti.sitemap.xml.templates.blacklist' => [], 'schnti.sitemap.xml.templates.whitelist' => [], 'schnti.sitemap.xml.showUnlistedSites' => false, 'schnti.sitemap.xml.showOnePagerModules' => false, 'schnti.sitemap.xml.showTags' => false, 'schnti.sitemap.html.sites.blacklist' => ['error', 'sitemap', 'thankyou'], 'schnti.sitemap.html.sites.whitelist' => ['home', 'impressum', 'datenschutzerklaerung'], 'schnti.sitemap.html.sites.prio' => [], 'schnti.sitemap.html.templates.blacklist' => [], 'schnti.sitemap.html.templates.whitelist' => [], 'schnti.sitemap.html.showUnlistedSites' => false, 'schnti.sitemap.html.showOnePagerModules' => false, 'schnti.sitemap.html.showTags' => false, 'schnti.sitemap.json.sites.blacklist' => ['error', 'sitemap', 'thankyou'], 'schnti.sitemap.json.sites.whitelist' => ['home', 'impressum', 'datenschutzerklaerung'], 'schnti.sitemap.json.sites.prio' => [], 'schnti.sitemap.json.templates.blacklist' => [], 'schnti.sitemap.json.templates.whitelist' => [], 'schnti.sitemap.json.showUnlistedSites' => false, 'schnti.sitemap.json.showOnePagerModules' => false, 'schnti.sitemap.json.showTags' => false ``` ### .sites.blacklist [](#sitesblacklist) An array of [Kirby page IDs](https://getkirby.com/docs/reference/objects/page/id) who are excluded from the sitemap. ### .sites.whitelist [](#siteswhitelist) An array of [Kirby page IDs](https://getkirby.com/docs/reference/objects/page/id) who are included if their status is unlisted. ### .sites.whitelist [](#siteswhitelist-1) ### .templates.blacklist [](#templatesblacklist) An array of [intended template names](https://getkirby.com/docs/reference/objects/page/intended-template) whose pages are excluded from the sitemap. ### .templates.whitelist [](#templateswhitelist) An array of [intended template names](https://getkirby.com/docs/reference/objects/page/intended-template) whose pages are included if their status is unlisted. ### .showUnlistedSites [](#showunlistedsites) If `true`, all unlisted sites are also included. ### .showOnePagerModules [](#showonepagermodules) If you are using the [Kirby Modules from Thomas Günther](https://github.com/medienbaecker/kirby-modules) this plugin hides automatically the "modules" page from the sitemap. If `showOnePagerModules` is `true` the OnePager Modules are shown as anker navigation links. ### .showTags (for experts) [](#showtags-for-experts) If `true`, for example blog categories or tags are listed as sub page navigation links. Internal the `$page->children()->listed()->pluck('tags', ',', true)` and `url($p->url(), ['params' => ['tag' => urlencode($tag)]])` function is used. How to use it ------------- [](#how-to-use-it) ### sitemap.xml (for search engines) [](#sitemapxml-for-search-engines) Visit the sitemap as XML: `http://example.com/sitemap.xml` There is no actual file generated. ### sitemap.json (for tools) [](#sitemapjson-for-tools) Visit the sitemap as JSON: `http://example.com/sitemap.json` There is no actual file generated. ### HTML sitemap (for humans) [](#html-sitemap-for-humans) Use this simple tag which lets you output an HTML sitemap. In your text file you can use it as follows: ``` (sitemap: ) ``` ### Health Score 38 — LowBetter than 83% of packages Maintenance41 Moderate activity, may be stable Popularity22 Limited adoption so far Community9 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~358 days Recently: every ~537 days Total 7 Last Release 490d ago Major Versions 0.1.0 → 1.0.02019-04-14 1.1.1 → 2.0.02020-01-08 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1868482?v=4)[Timo Schneider](/maintainers/schnti)[@schnti](https://github.com/schnti) --- Top Contributors [![schnti](https://avatars.githubusercontent.com/u/1868482?v=4)](https://github.com/schnti "schnti (9 commits)") --- Tags kirbykirby-pluginkirby-cms ### Embed Badge ![Health badge](/badges/schnti-sitemap/health.svg) ``` [![Health](https://phpackages.com/badges/schnti-sitemap/health.svg)](https://phpackages.com/packages/schnti-sitemap) ``` ### Alternatives [medienbaecker/kirby-modules Easily add modules to your pages 895.5k1](/packages/medienbaecker-kirby-modules)[belugadigital/kirby-navigation Kirby 5 field for hierarchical menus with drag & drop level indentation. 8614.7k](/packages/belugadigital-kirby-navigation)[bnomei/kirby3-dotenv Kirby Plugin for environment variables from .env 4149.6k2](/packages/bnomei-kirby3-dotenv)[bnomei/kirby3-recently-modified Kirby Section to display recently modified content pages 3210.6k](/packages/bnomei-kirby3-recently-modified)[grommasdietz/kirby-hidden-characters Kirby CMS plugin for visualising hidden characters in the Panel 461.8k](/packages/grommasdietz-kirby-hidden-characters)[bnomei/kirby3-robots-txt Manage a virtual robots.txt from the Kirby config file 2250.1k](/packages/bnomei-kirby3-robots-txt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)