README

A simple SEO plugin for Kirby CMS. Edit SEO meta fields and Open Graph data from the panel on a per page basis, with site-wide fallbacks and sensible defaults.

Features

Set per-page meta title, description and robot directives
Generate Open Graph tags for social media sharing
Generate Schema.org (JSON-LD) structured data
Generate an XML sitemap
All features can be enabled/disabled via configuration
Blueprints can be translated. English and German translations are included.
Dependency free, and supports manual installation

Install

Install via Composer:

composer require jnicol/kirby-simple-seo

Manual installation

Copy the contents of this folder to /site/plugins/kirby-simple-seo.

Setup

Include the SEO site tab in your site.yml and the SEO page tab in all your page blueprints:

# site.yml
tabs:
  seo: simple-seo/tab/site

# e.g. default.yml
tabs:
  seo: simple-seo/tab/page

The page tab includes fields for editing per-page metadata, such as metaTitle, metaDescription, ogImage and robots directives.

The site tab adds siteDescription, metaTitle and ogImage fields to your dashboard, which define site-wide metadata and/or serve as a fallback if a page does not have any metadata defined.

Usage in template

// in <head> of a page template
<?php snippet('simple-seo/head') ?>

Options

Options can be set in /site/config/config.php:

return [
  'jnicol.simple-seo' => [
    'titleSeparator'  => '|',
    'autoImages' => ['cover_image'],
  ]
]

All options

Property	Type	Default	Description
appendSiteTitle	`bool`	`true`	Append the site title to auto-generated page titles.
autoImages	`array`	`[]`	Array of fields to use as the Open Graph image if one was not manually defined. The first matching field will be used.
canonical	`bool`	`true`	Generate canonical URL tag.
locale	`string`	`''`	The langage your website is written in. Use one of the language codes from the IETF BCP 47 standard.
meta	`bool`	`true`	Generate general meta tags.
title	`bool`	`true`	Generate title tag.
titleSeparator	`string`	`'-'`	A visual separator between the page and site title.
robots	`bool`	`true`	Generate robots meta tag.
robotsIndex	`bool`	`true`	Allows crawlers to index pages. Can be disallowed per-page.
robotsFollow	`bool`	`true`	Allows crawlers to follow links on pages. Can be disallowed per-page.
robotsArchive	`bool`	`true`	Allows crawlers to serve cached page versions. Can be disallowed per-page.
robotsImageIndex	`bool`	`true`	Allows crawlers to include images in search results. Can be disallowed per-page.
sitemap	`bool`	`true`	Generate XML sitemap.
sitemapExclude	`array`	`['error']`	An array of page slugs to exclude from the sitemap.
social	`bool`	`true`	Generate Open Graph meta tags.
schema	`bool`	`true`	Generate JSON-LD schema data.
schemaExtra	`array`	`[]`	Additional data to include in the schema.org @graph object, defined as a PHP array.

Sitemap

A sitemap.xml file is automatically generated at the site's root.

Pages can be excluded from the sitemap with the sitemapExclude config setting.

Schemas

Schema.org (JSON-LD) structured data is automatically added to each page, and includes WebSite and WebPage schemas. You can add your own schemas using the schemaExtra config option. Here is an example of adding an Organization schema:

return [
  'jnicol.simple-seo' => [
    'schemaExtra' => [
      [
        '@type' => 'Organization',
        'url' => 'https://www.example.com',
        'sameAs' => ['https://example.net/profile/example1234', 'https://example.org/example1234'],
        'logo' => 'https://www.example.com/images/logo.png',
        'name' => 'Example Corporation',
        'description' => 'The example corporation is well-known for producing high-quality widgets',
      ]
    ]
  ]
]

Made by Jonathan Nicol and released under an MIT license.

jnicol / kirby-simple-seo

Package info

Security

Statistics