reh/kirby-seo-preview-section

Configurable & interactive SEO preview section for the Kirby 3 Panel.

v1.0 2019-12-07 16:23 UTC

Requires

• getkirby/composer-installer: ^1.1

MIT

• REH.vision

README

Configurable & interactive SEO preview section for the Panel in Kirby 3+.

Installation

Choose one of the following installation methods:

Manually

Download and copy this repository to /site/plugins/seo-preview-section.

Git submodule

git submodule add https://github.com/REHvision/kirby-seo-preview-section.git site/plugins/seo-preview-section

Composer

composer require reh/kirby-seo-preview-section

Setup

After installing this plugin, you can add the seopreview section to your blueprints.

The easiest way to use it in multiple page blueprints is a tab blueprint (e.g. site/blueprints/tabs/meta.yml):

# site/blueprints/tabs/meta.yml

label: SEO
icon: search
columns:

  - width: 1/2
    fields:

      metatitle:
        label: Meta title
        type: text

      metadescription:
        label: Meta description
        type: textarea

  - width: 1/2
    sections:

      seopreview:
        type:                seopreview

#       options:             defaults:
        headline:            SEO preview

        titleField:          metatitle        # field key reference
        defaultTitle:        page.title       # query (e.g: page.myCustomSeoTitle)
        separator:           " "
        baseTitle:           site.title       # query (e.g. site.metatitle)

        descriptionField:    metadescription  # field key reference
        defaultDescription:  page.text        # query (e.g: page.text.blocks.html when using the editor)

that can be reused in the tab definition of site and any page blueprints:

tabs:

    # just use meta.yml
    meta: tabs/meta

    # or extend/overwrite it in this blueprint/template
    meta:
        extends: tabs/meta
        defaultDescription: page.text.blocks.html

NOTE: This plugin only provides a preview and does not generate any meta tags!

So make sure to wire the fields you use for meta tag generation and that the output of the preview mimics your actual meta tags!

Status & Development

STATUS:

first public release (only yet tested with Kirby 3.3.1 in single-language setup)

IMPORTANT:

Although this plugin should not be able to break anything, please always test it in your dev-environment before using it in production!

FEEDBACK:

I'm happy to receive feedback (bugs, optimization suggestions or in general)

TODO:

• Add composer compatibility
• Test with multi-language setups
• Document the plugin options
• Add instructions on how to help working on the plugin

License

MIT