archtechx/laravel-seo
1
0
Fork 0
mirror of https://github.com/archtechx/laravel-seo.git synced 2025-12-12 01:44:03 +00:00
Code Activity

finished

Browse source
This commit is contained in:
Samuel Štancl 2021-05-24 10:53:00 +02:00
parent 051a32575c
commit b12c9ecb55
21 changed files with 750 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

190
README.md
View file

@ -1,41 +1,195 @@
# REPLACE
# laravel-seo
Simple and flexible package template.
This is a simple package for improving SEO via OpenGraph and Twitter meta tags.
# Usage
It's semi-opinionated, as it's what we use for all of our websites. At the same time, it's not overengineered like many other SEO packages.
- Replace all occurances of `REPLACE` (case sensitive) with the name of the package namespace. E.g. the `Foo` in `ArchTech\Foo`.
- Replace all occurances of `replace2` with the name of the package on composer, e.g. the `bar` in `archtechx/bar`.
- If MySQL is not needed, remove `docker-compose.yml`, remove the line that runs docker from `./check`, and set `DB_CONNECTION` in `phpunit.xml` to `sqlite`, and `DB_DATABASE` to `:memory:`.
**Features**:
- Setting SEO tags from PHP
- Setting SEO tags from Blade
- Integration with [Flipp](https://useflipp.com), to automatically generate cover images
- Custom extension support
- Expressive & simple API
---
Example usage:
```php
seo()
->title($post->title)
->description($post->excerpt)
->flipp('blog')
// Adds OpenGraph tags
// Adds Twitter card tags
// Generates social image using Flipp and sets it as the cover photo
```
## Installation
```sh
composer require stancl/replace2
composer require archtechx/laravel-seo
```
And add the following line to your layout file's `<head>` tag:
```html
<x-seo::meta />
```
## Usage
The package can be used from any PHP code, or specifically from Blade using the `@seo` directive.
### PHP
Use the `seo()` helper to retrieve the SeoManager instance, on which you can call the following methods:
Available methods:
```js
site(string $site)
title(string $title)
description(string $description)
image(string $url)
twitterUser(string $username)
twitterTitle(string $title)
twitterDescription(string $description)
twitterImage(string $url)
```
Example usage:
```php
// ...
seo()->title('foo')->description('bar')
```
### Blade views
You can use the `@seo` directive to call the methods from Blade:
```html
@seo('title') // Echoes the title
@seo('title', 'foo') // Sets the title & echoes it
@seo(['title' => 'foo']) // Sets the title without echoing it
```
In general, you'll want to use `@seo(['title' => 'foo'])` at the start of a view — to set the values — and `@seo('title')` inside the view if you wish to fetch the value.
That is, if you'll use the helpers in Blade at all. Some apps will only use the PHP helper.
For Twitter, use the `twitter.author` format, e.g. `@seo('twitter.author')`.
### Defaults
To configure default values, call the methods with the `default` argument:
```php
seo()
->title(default: 'ArchTech — Meticulously architected web applications')
->description(default: 'We are a web development agency that ...');
```
### Modifiers
You may want to modify certain values before they get inserted into the template. For example, you may want to suffix the meta `<title>` with `| ArchTech` when it has a non-default value.
To do that, simply add the `modify` argument to the method calls like this:
```php
seo()->title(modify: fn (string $title) => $title . ' | ArchTech');
```
You can, of course, combine these with the defaults:
```php
seo()->title(
default: 'ArchTech — Meticulously architected web applications',
modify: fn (string $title) => $title . ' | ArchTech'
);
```
Which will make the package use the default if no title is provided, and if a title is provided using e.g. `seo()->title('Blog')`, it will be modified **right before being inserted into the template**.
### Flipp integration
First, you need to add your Flipp API keys:
1. Add your API key to the `FLIPP_KEY` environment variable. You can get the key [here](https://useflipp.com/settings/profile/api).
2. Go to `config/services.php` and add:
```php
'flipp' => [
'key' => env('FLIPP_KEY'),
],
```
Then, register your templates:
```php
seo()->flipp('blog', 'v8ywdwho3bso');
seo()->flipp('page', 'egssigeabtm7');
```
After that, you can use the templates by calling `seo()->flipp()` like this:
```php
seo()->flipp('blog', ['title' => 'Foo', 'content' => 'bar'])`
```
The call will set the generated image as the OpenGraph and Twitter card images. The generated URLs are signed.
If no data array is provided, the method will use the `title` and `description` from the current SEO config:
```php
seo()->title($post->title);
seo()->description($post->excerpt);
seo()->flipp('blog');
```
The `flipp()` method also returns a signed URL to the image, which lets you use it in other places, such as blog cover images.
```php
<img alt="@seo('title')" src="@seo('flipp', 'blog')">
```
## Customization
### Views
You can publish views running `php artisan vendor:publish --tag=seo-views`.
### Extensions
To use a custom extension, create a Blade *component* with the desired meta tags. The component should read data using `{{ seo()->get('foo') }}` or `@seo('foo')`.
For example:
```php
<meta name="facebook-title" content="@seo('facebook.foo')">
```
Once your view is created, register the extension:
```php
seo()->extension('facebook', view: 'my-component')
// The extension will use <x-my-component>
```
To set data for an extension (in our case `facebook`), simply prefix calls with the extension name in camelCase, or use the `->set()` method:
```php
seo()->facebookFoo('bar')
seo()->facebookTitle('About us')
seo()->set('facebook.description', 'We are a web development agency that ...')
seo(['facebook.description' => 'We are a web development agency that ...'])
```
To disable an extension, set the second argument in the `extension()` call to false:
```php
seo()->extension('facebook', false);
```
## Development
Running all checks locally:
Run all checks locally:
```sh
./check
```
Running tests:
```sh
MYSQL_PORT=3307 docker-compose up -d
phpunit
```
Code style will be automatically fixed by php-cs-fixer.