README

Kirby SERP Preview

注意

之前使用过v0.x版本？升级很简单！请阅读迁移指南以了解v1.0版本中的更改。

一个独立的搜索引擎结果页面预览，可以包含在任何Kirby项目中。它允许您预览您的页面在Google和其他搜索引擎的搜索结果中的外观。

要求

Kirby 4+

Kirby不是免费软件。然而，您可以在本地机器或测试服务器上尝试Kirby和Starterkit，只要您需要确保它适合您的下一个项目。 ...当您确信时，请购买您的许可证。

安装

Composer

composer require johannschopplich/kirby-serp-preview

下载

下载并将此存储库复制到 /site/plugins/kirby-serp-preview。

入门

在您的blueprints中的一个新建部分

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 }}"

用法

页面标题

提示

tl;dr 标题的生成顺序如下

titleContentKey
defaultTitle
将页面标题、titleSeparator和siteTitle连接起来。

默认情况下，SERP预览将通过空格连接以下值来渲染搜索引擎结果页面预览的标题

1️⃣ 页面标题
2️⃣ 标题分隔符（默认为–）
3️⃣ 网站标题

但是，您可以通过使用以下部分属性来覆盖上面的标题生成

当titleContentKey被设置，并且当前页面上相应的字段不为空时，它将被用作标题。
当设置了defaultTitle，如果titleContentKey为空，它将用作标题。

配置

每个配置选项都是string类型。其中一些支持Kirby查询。例如，您可以使用{{ site.title.value }}作为siteTitle选项。

以下表格列出了所有可用的选项

迁移

每个主要版本可能引入破坏性更改、新功能或弃用旧功能。迁移指南将帮助您了解发生了什么更改以及如何使您的项目适应新版本。

从v0.x到v1.0

descriptionFallback部分属性已重命名为defaultDescription。请相应更新您的blueprints。

johannschopplich / kirby-serp-preview

维护者

详细信息

README

Kirby SERP Preview

要求

安装

Composer

下载

入门

用法

页面标题

配置

迁移

从v0.x到v1.0

许可证