README

Kirby SEO Audit

Kirby SEO Audit is a plugin for Kirby CMS that brings the Yoast SEO analysis engine into the Panel. The analysis runs in the editor's browser; no external services, no data sent to third parties.

Features

• 🎛️ View Button & Section: Run the analysis from the page header or inline in a section.
• 🔍 SEO & Readability Assessments: Powered by the Yoast SEO engine, plus checks of our own.
• 📊 Result Groups: Every result sorted into Good, OK, Needs improvement, Feedback, or Errors.
• 🚦 SEO & Readability Ratings: One light per category. The view button shows the page's rating, kept per page and language and readable in blueprints and templates.
• ✍️ Unsaved Changes: The analysis reads what the form shows, before the page is published.
• 🎯 Keyphrase Field: Extra checks against the page's keyphrase.
• 🌐 Language-Specific Features: Analysis rules picked from the page's lang attribute.
• 🔒 Local Analysis: Runs in the editor's browser, no external service involved.

Licensing

Kirby SEO Audit is a commercial plugin that requires a license. You can install and test the plugin locally without a license. However, production environments require a valid license. You can purchase a license from the Kirby SEO Audit Website.

Requirements

• Kirby 4 or Kirby 5

Installation

Composer (Recommended)

composer require johannschopplich/kirby-seo-audit

Manual Installation

Download and copy this repository to /site/plugins/kirby-seo-audit.

Documentation

For installation, configuration, and usage, see the Kirby SEO Audit documentation.

Support and Questions

We are committed to support you if you have any questions or issues with Kirby SEO Audit. There are several ways to get support:

• GitHub Discussions: Join the community and engage in discussions on our GitHub Discussions page.
• Email Support: You can ask questions and seek assistance by emailing us at hello@kirby.tools. Please use the GitHub discussions if you have a general question or comment about Kirby SEO Audit.
• GitHub Issues: For reporting bugs or requesting new features, please use the GitHub Issues page.

We encourage you to use the resources above to connect with us and other users of Kirby SEO Audit.

For the sake of reproducible bug reports, please include the following information in your bug reports:

• Kirby & Kirby SEO Audit version
• Browser environment (name, version, operating system)
• Global and section configuration (without any sensitive information)
• Steps to reproduce the bug (if no reproduction is provided)
• Screenshots or screen recordings if applicable

Feedback

We value your feedback and ideas for improving Kirby SEO Audit. If you have any suggestions, please feel free to reach out to us via email or preferably by creating a new discussion on our GitHub Discussions page.

License

Kirby Tools License © 2024-PRESENT Johann Schopplich