Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johannschopplich/kirby-serp-preview

🔍 Kirby Panel plugin for search engine result page previews
https://github.com/johannschopplich/kirby-serp-preview

kirby-cms kirby-plugin kirby-seo kirby-theme

Last synced: 15 days ago
JSON representation

🔍 Kirby Panel plugin for search engine result page previews

Host: GitHub
URL: https://github.com/johannschopplich/kirby-serp-preview
Owner: johannschopplich
License: mit
Created: 2023-12-10T15:12:07.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-04-29T05:42:44.000Z (7 months ago)
Last Synced: 2024-04-29T06:38:16.438Z (7 months ago)
Topics: kirby-cms, kirby-plugin, kirby-seo, kirby-theme
Language: PHP
Homepage: https://kirbyseo.com
Size: 425 KB
Stars: 16
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

![Kirby Search Engine Result Page Preview](./.github/kirby-serp-preview.png)

# Kirby SERP Preview

> [!NOTE]
> Used v0.x before? Upgrading is easy! Please read to the [migration guide](#migration) to learn more about the changes in v1.0.

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.

## Requirements

- Kirby 4+

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](https://getkirby.com/buy).

## Installation

### Composer

```bash
composer require johannschopplich/kirby-serp-preview
```

### Download

Download and copy this repository to `/site/plugins/kirby-serp-preview`.

## Getting Started

Create a new section in one of your blueprints:

```yml
sections:
serp-preview:
type: serp-preview
siteTitle: "{{ site.title.value }}"
siteUrl: "{{ site.url }}"
# Optional field to override the computed title
titleContentKey: metaTitle
# Optional default title as fallback if the field above is empty
defaultTitle: "{{ page.metaTitle.value }}"
descriptionContentKey: metaDescription
# Optional default description as fallback if the field above is empty
defaultDescription: "{{ site.metaDescription.value }}"
```

## Usage

### Page Title

> [!TIP]
>
> **tl;dr** The title is computed in the following order:
>
> 1. `titleContentKey`
> 2. `defaultTitle`
> 3. Joining the page title, `titleSeparator`, and `siteTitle`.

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 the `titleContentKey` 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` | `"{{ site.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. |

## Migration

Each major release might introduce breaking changes, new features, or deprecate old ones. The migration guide will help you to understand what has changed and how to adapt your project to the new version.

### From v0.x to v1.0

- The `descriptionFallback` section property has been renamed to `defaultDescription`. Please update your blueprints accordingly.

## License