as-milano / wn-seo-plugin
支持生成网站地图的SEO插件。
Requires
- php: ^8.0.2
- composer/installers: ~1.0
- spatie/schema-org: ~3.11
- winter/storm: ~1.2.0
- winter/wn-backend-module: ~1.2.0
- winter/wn-cms-module: ~1.2.0
- winter/wn-system-module: ~1.2.0
This package is auto-updated.
Last update: 2024-09-24 01:22:53 UTC
README
安装
您可以使用Composer安装插件
composer require "as-milano/wn-seo-plugin"
如何使用
元标签
要启用元标签,请将SEO组件放置在您的布局中一个或多个位置。请确保从设置页面启用元标签。
动态元标签
SEO元标签字段支持twig语法,这使得在您有大量记录的网站中更加灵活,您需要使用它们的属性值用于搜索结果,或从模型字段生成页面的标题和描述。
Winter.Translate
支持
twig语法非常有用,它允许您执行如下操作
{{ "This is the meta title of my page" | _ }}
在首次渲染页面后,字符串将通过 Winter.Translate
的 _
过滤器注册为翻译消息。这意味着这些元标签可以成为多语言。
限制
- Sitemap.xml字段不使用动态字段。
- 如果您在schema.org组件的属性字段中只使用一个
{{ }}
,您需要从页面代码(而非October界面)中至少添加一个尾随空格。示例
[schemaVideo]
description = "{{ episode.serie.summary }} " <-- this is the trailing space
自动化sitemap.xml
要自动生成sitemap.xml,请按照以下步骤操作
请确保您已在设置页面中启用了sitemap.xml。
转到您的CMS编辑器页面,静态或博客文章页面,并在“SEO”标签中检查“在sitemap.xml中启用”复选框。
访问:http(s)://yourdomain.tld/sitemap.xml
注意: “网站地图”部分中的字段不是动态的。
自定义模型
如果您有一个希望从中生成链接的自定义模型,请将您的模型的全名添加到 CMS页面 的“设置”标签中。如果页面有 blogPost
组件,则无需设置模型类。
重要:页面的URL参数,例如:/post/:slug
,将被具有相同名称的模型的属性值替换,因此您必须确保在这种情况下模型有一个名为 slug
的属性。
添加结构化数据(schema.org)
插件附带定义了一些schema.org对象(文章、产品和VideoObject)的组件。这些组件也作为 Winter.Pages
的片段可用,它们的属性支持twig语法。
如果您不熟悉结构化数据,强烈建议您阅读 Google指南
要使用这些组件,只需将您需要的组件从检查器拖到页面编辑器即可。 不要 将它们放置在页面代码中,因为它们由 seo
组件渲染。
重要:包含在 {{ }}
中的组件字段值将被October自动解释为外部属性(https://octobercms.com/docs/cms/components#external-property-values)。如果您只有一个花括号对,那么如果October找不到外部属性,输出将为空字符串。作为一种解决方案,您必须添加尾随空格,如下所示
但是,如果您使用多个花括号,则不需要添加任何空格。
Open Graph & Twitter cards
配置通过“开放图”标签页进行。如果您不了解这些标签,请阅读来自Facebook的开放图指南和来自Twitter的Twitter卡片指南。
注意:Twitter卡片将自动从OG *字段设置。
当前支持的标签包括
og:title
默认为页面meta_title | 页面标题og:description
默认为在设置页面中的页面meta_description | 网站描述og:image
默认为设置页面 - 开放图标签页中的页面图像 | 网站图像og:type
默认为"网站"。og:site_name
在设置页面中设置。twitter:title
来自og:title
twitter:description
来自og:description
twitter:image
来自og:image
注意:请阅读上面链接的Facebook和Twitter的指南,了解这些标签的推荐值。