presprog / kirby-seo-plugin
Opinionated SEO plugin for Kirby 4. With meta description, open graph, sitemap and robots.txt
Installs: 72
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:kirby-plugin
Requires
- getkirby/cms: ^4.0
- getkirby/composer-installer: ^1.1
This package is auto-updated.
Last update: 2024-04-23 06:35:31 UTC
README
This is our opionated take on a SEO plugin for Kirby 4. Edit meta descriptions and open graph data from within the panel – per page with a site-wide default – or programmatically.
Install
Install with composer
composer require presprog/kirby-seo-plugin
Setup
Include the SEO site tab in your site.yml and the SEO page tab in all your page blueprints
# site.yml
tabs:
seo: seo/tabs/site
# e.g. default.yml
tabs:
seo: seo/tabs/page
The site tab includes metadescription and ogimage fields on your dashboard. These serve as fallback if a page does not have any metadata itself.
The page tab includes fields for meta title, description and Open Graph Image (share pic). You have three generic previews to see how your page being shared on different platforms may look. When you do not define these, the plugin fallsback to the page title and the fallbacks for decsription and Open Graph Image from site.yml.
Use in template
// in <head> of a page template <?php snippet('seo/head') ?>
Hierarchy
This plugin will look for an Open Graph image in the following order:
- Page image (The image defined in the page blueprint)
- Page model image (The image defined programmatically in a page model)
- Site image (The site-wide fallback)
The original version of this plugin started as a copy of the metadata plugin included in getkirby.com website Repository. We stripped it down to what we needed and started using it in multiple of our own sites. Thanks to the Kirby team for sharing their work.
Made with ♥️ and ☕ by Present Progressive
