Installation

Step 1: Install the Plugin

Although it is a commercial plugin, you can download and test it in your local environment before purchasing.

composer require johannschopplich/kirby-seo-audit

Step 2: Choose Your Workflow

Kirby SEO Audit offers two ways to add SEO analysis to the Panel. Both run the same analysis, share their configuration, and can be used together – the section additionally remembers its last report through persisted.

buttons:
  - seo-audit # Choose position
  - open # `buttons` replaces Kirby's
  - preview # defaults, so list them all
  - "-"
  - settings
  - languages
  - status

seoAudit:
  type: seo-audit

Step 3: Configure Keyphrase Fields (Optional)

SEO assessments that analyze how the keyphrase is used, such as Introduction Keyword, Meta Description Keyword, or Function Words, need a defined keyphrase – see keyphraseField for what happens without one. You can define blueprint fields for the keyphrase and its synonyms to be analyzed with your page. These fields can be used by both the view button and section:

# Configure the view button to use keyphrase fields
buttons:
  seo-audit:
    keyphraseField: metaKeyphrase
    synonymsField: metaSynonyms
  open: true
  preview: true
  settings: true
  languages: true
  status: true

sections:
  # Define the keyphrase fields
  content:
    type: fields
    fields:
      metaKeyphrase:
        label: SEO Keyphrase
        type: text
        help: The keyphrase you want this page to rank for
      metaSynonyms:
        label: Keyphrase Synonyms
        type: tags
        help: Synonyms and variations of the keyphrase

  # Configure the section to use the same fields
  seoAudit:
    type: seo-audit
    keyphraseField: metaKeyphrase
    synonymsField: metaSynonyms

Step 4: Analyze Your Content

Open the Panel and navigate to the page that you want to analyze. You can start the analysis in two ways:

• Using the View Button: Click the SEO Audit button and the analysis results will open in a dialog.
• Using the Section: Click the Analyze button in the section. The results will be displayed directly in the section.

With the view button, the report opens in a dialog:

The analysis reads the page behind its preview URL, unsaved changes included.

Step 5: Buy a License

You can test the plugin locally. However, you need to purchase a license to use the plugin in production environments.

Visit the buy page and purchase a license. The easiest way to activate your license is to go to the system view in the Kirby Panel and click on Activate now:

Enter the email you used for the purchase and your license key, then hit the submit button. You will find your license key in your order confirmation email or at hub.kirby.tools. Done! Thanks for supporting my work. Once you activate your license, the license activation buttons will disappear.