Download the PHP package johannschopplich/kirby-serp-preview without Composer
On this page you can find all versions of the php package johannschopplich/kirby-serp-preview. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download johannschopplich/kirby-serp-preview
More information about johannschopplich/kirby-serp-preview
Files in johannschopplich/kirby-serp-preview
Package kirby-serp-preview
Short Description Kirby Panel plugin for search engine result page previews
License MIT
Homepage https://github.com/johannschopplich/kirby-serp-preview#readme
Informations about the package kirby-serp-preview
Kirby SERP Preview
A standalone search engine result page preview to include in any Kirby project. It allows you to preview how your page will look in the search results of Google and other search engines.
[!TIP] New: Ready for Kirby 5! The plugin adapts to the Panel theme and uses Google's dark mode colors if the theme is set to dark.
Requirements
- Kirby 4 or Kirby 5
Kirby is not free software. However, you can try Kirby and the Starterkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you're convinced, buy your license.
Installation
Composer
Download
Download and copy this repository to /site/plugins/kirby-serp-preview
.
Getting Started
Create a new section in one of your blueprints. The following example includes all available options with their respective default values:
Usage
Page Title
[!TIP]
tl;dr The title is computed in the following order:
titleContentKey
defaultTitle
- Joining the page title,
titleSeparator
, andsiteTitle
.
By default, the SERP preview will render the title of the search engine result page preview by joining the following values with a space:
- 1️⃣ Page Title
- 2️⃣ Title Separator (defaults to
–
) - 3️⃣ Site Title
However, you can override the title generation above by using the following section properties:
- When
titleContentKey
is set and the corresponding field on the current page is not empty, it will be used as the title. - When
defaultTitle
is set, it will be used as the title if thetitleContentKey
is empty.
Configuration
Each configuration option is of type string
. Some of them support Kirby queries. For example, you can use {{ site.title.value }}
for the siteTitle
option.
The following table lists all available options:
Option | Default | Queryable | Description |
---|---|---|---|
faviconUrl |
null |
✅ | The URL to the favicon. |
siteTitle |
"{{ site.title.value }}" |
✅ | The site title. |
siteUrl |
"{{ kirby.url }}" |
✅ | The site URL. |
titleSeparator |
"-" |
✅ | The title separator between the current page title and the site title. Only applies if no titleContentKey is set and the target field value is empty. |
titleContentKey |
null |
– | The content key for a custom title. |
defaultTitle |
null |
✅ | Plain text or Kirby query to use as a fallback instead of 1️⃣2️⃣3️⃣ if the titleContentKey is empty. |
descriptionContentKey |
null |
– | The content key for the page's custom description. |
defaultDescription |
null |
✅ | Plain text or Kirby query to use as a fallback if the descriptionContentKey is empty. |
searchConsoleUrl |
null |
– | If provided, the section will display a link to the Google Search Console. |
License
Johann Schopplich
Dennis Baum