сашагм / seo
我们的服务旨在简化您网站创建和管理元标签的过程。元标签是搜索引擎优化的重要组成部分,可以帮助提升您网站在搜索结果中的排名。
Requires
- php: ^8.0
Requires (Dev)
- phpunit/phpunit: ^10.2
README
SEO 构建器
欢迎使用我们的元标签服务文档!
我们的服务旨在简化您网站创建和管理元标签的过程。元标签是搜索引擎优化的重要组成部分,可以帮助提升您网站在搜索结果中的排名。
我们希望我们的服务能帮助您提高网站在搜索引擎中的排名,并简化元标签的管理。如果您有任何问题或建议,请随时联系我们的客服。
目录
要求
安装和正常运行的主要要求
PHP
>= 8.0Laravel
>= 10.x || >= 11.xComposer
>= 2.4.x
安装
- composer require sashagm/seo
- php artisan seo:install
使用
让我们首先在 .env
中定义我们的辅助元数据。
APP_NAME="Laravel" APP_OG_TYPE="website" APP_OG_LOCALE="ru_RU" APP_OG_IMAGE="/storage/images.jpg" APP_KEYWORDS="" APP_DESC="" APP_ROBOTS="" APP_OG_TITLE="" APP_OG_DESC=""
要将元标签添加到页面中,您需要将相应的代码插入到 layouts/app.blade.php
文件的 HTML 代码的相应部分,并指定指令 @yield('meta')
。
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>@yield('title')</title> @yield('meta') </head> <body> <div class="container"> @yield('content') </div> </body> </html>
入门使用
要将元标签添加到特定页面,您需要在 resources/views/pages/example.blade.php
文件中指定相应的值在 @section('meta') 部分中。
@section('meta') @meta('key') @endsection
在这里,我们输出模型中的 keywords
、description
、robots
、og_title
、og_description
的值,如果传递了额外的描述,则输出该描述而不是模型中的描述。如果没有传递额外的描述,则只输出模型中的描述。
现在我们可以为每个页面单独定义元标签,并通过指令 @yield('meta') 将它们传递到我们的布局中。这使我们能够更灵活地管理元标签,并提高网站的 SEO 优化。让我们看看模型方法 getPageMeta('key')
的用法,我们将传递我们的类别键。搜索将根据第一个参数从模型中进行。
@meta('key')
自定义描述
如果需要自定义描述,只需作为第二个参数传递我们的字符串即可,它将显示为我们的 key->description 的替代内容。
@meta('key','custom description')
自定义 og 描述
如果需要自定义 og 描述,只需作为第二个参数传递空字符串,并作为第三个参数传递我们的字符串即可,它将显示为我们的 key->og_description 的替代内容。
@meta('key','','custom og description')
自定义描述和 og 描述
如果需要自定义描述和 og 描述,只需作为第二个参数传递描述字符串,并作为第三个参数传递 og 描述字符串即可,它们将分别显示为我们的 key->og_description 和 key->og_description 的替代内容。
@meta('key','custom description','custom og description')
获取数据
模型函数的调用示例
- 使用属性访问获取
robots
属性的值
$meta = Meta::find(1); $robots = $meta->robots;
- 使用属性访问获取
og_title
属性的值
$meta = Meta::find(1); $ogTitle = $meta->og_title;
- 使用属性访问获取
og_description
属性的值
$meta = Meta::find(1); $ogDescription = $meta->og_description;
- 使用属性访问获取
description
属性的值
$meta = Meta::find(1); $description = $meta->description;
- 使用属性访问获取
keywords
属性的值
$meta = Meta::find(1); $keywords = $meta->keywords;
在所有示例中,我们使用方法 find() 获取具有特定标识符(在本例中为 1)的模型 Meta 实例。然后我们访问所需的属性,例如 $meta->robots,以获取其值。如果属性值未设置(NULL),则返回相应函数访问器中指定的默认值。
附加功能
我们的包提供了一系列额外的功能,这些功能在处理SEO时可能非常有用。
php artisan seo:install
- 这个命令将安装所有必要的文件。
测试
为了检查其工作状态,可以执行以下特殊命令
- ./vendor/bin/phpunit --configuration phpunit.xml
许可证
SEO Builder 是一款开源软件,遵循 MIT 许可协议。