heywhy / seotamic

A Statamic v3 SEO addon

PRO Version: If you are having issues with the license, make sure to add 'cnj/seotamic' => 'pro' in the config/statamic/editions.php addons array.

Seotamic - Statamic SEO Addon

Statamic v3.3+ only. Automatically adds a SEO tab to all your collection entries where you can fine tune SEO for every entry. Works perfectly with Antlers, Blade and in headless mode (PRO edition) with the Statamic REST API or GraphQL integration out of the box.

Quick Antlers usage sample

{{ seotamic }}

Generates the whole array of SEO settings:

<title>My Page Title</title>
<meta name="description" content="SEO friendly description" />
<link rel="canonical" href="https://mysite.com/page" />
<meta property="og:url" content="https://mysite.com/page" />
<meta property="og:site_name" content="Site name" />
<meta property="og:title" content="My Page Title" />
<meta property="og:description" content="SEO friendly description" />
<meta property="og:image" content="https://mysite.com/img/og.jpg" />
...

Version 3 changes

Version 3 has breaking changes. If you update from version 1 or 2, your global settings will not be transfered. The data layout is a bit different and so is the data on specific entries.

The string tags were changed to arrays so to access the data you need to use the :meta or :social prefixes. For example {{ seotamic:title }} becomes {{ seotamic:meta:title }}.

Migration from version 2

If you are migrating from version 2, you can use the following command to migrate your data:

php artisan seotamic:migrate

This will migrate your global settings and all the entries. It will also remove the old fields from the entries. Make sure to backup your data before running the command.

Installation

Include the package with composer:

composer require cnj/seotamic

The package requires Laravel 9+ and PHP 8.0+. It will auto register.

The SEO & Social section tab will appear on all collection entries automatically.

Configuration (optional)

You can override the default options by publishing the configuration:

php artisan vendor:publish --provider="Cnj\Seotamic\ServiceProvider" --tag=config

This will copy the default config file to `config/seotamic.php'.

If you need to change the default assets container, make sure to apply the change in the Blueprints as well.

Usage

Usage is fairly simple and straight forward. You can visit the global Settings by following the Seotamic link on the navigation in the CP. Make sure to follow the instructions on each field.

After this you can fine tune the output of each collection entry by editing the SEO settings under the entry's SEO tab. In version 3 you can also preview the output of the meta and social settings. The previews should give an accurate representation of the output.

Antlers

There are several antler tags available, the easiest is to just include the do everything base tag in the head of your layout:

{{ seotamic }}

If you need more control you can manually get each part of the output by using:

{{ seotamic:meta:title }}
{{ seotamic:meta:description }}
{{ seotamic:meta:canonical }}
{{ seotamic:meta:robots }}

This will return strings, so you need to wrap them in the appropriate tags, ie:

<title>{{ seotamic:meta:title }}</title>

Social ones will still return everything with these tags (the general one returns this as well)

{{ seotamic:og }}
{{ seotamic:twitter }}

If you need more control you can manually get each part of the output by using:

{{ seotamic:social:title }}
{{ seotamic:social:description }}
{{ seotamic:social:image }}
{{ seotamic:social:site_name }}

This will return strings, so you need to wrap them in the appropriate tags.

Blade

Similarly to the Antlers usage, you can use the same tags using Blade:

{!! Statamic::tag('seotamic')->context(get_defined_vars()) !!}

It works similary to the Antlers tags, so you can use single values as well.

Headless (PRO)

Headless use is straightforward. If using the REST API or GraphQL, the entry will include three Seotamic fields: seotamic_meta, seotamic_social with the prefilled SEO data.

Headless usage is supported only for the PRO version.

Sitemap (PRO)

Sitemap is autogenerated under the /sitemap.xml url if the sitemap config options are set to true (default).

Sitemap is supported only for the PRO version.

Dynamic OG Image injection

In projects where you want the OG Image to be dynamic, for now you can use this ViewModel and inject it to your collection in order to dynamically assign the OG Image.

<?php

namespace App\ViewModels;

use Statamic\View\ViewModel;

class OgImage extends ViewModel
{
    public function data(): array
    {
        $social = $this->cascade->get('seotamic_social');

        if ($social) {
          return [ ...$social, 'image' => 'https://myimageurl.com/image.jpg', ];
        }

        return [];
    }
}

In the example above we use a hardcoded image url which you can change to suit your usecase. Then in your collections you just have to inject the ViewModel.

title: Posts
inject:
  view_model: App\ViewModels\OgImage

Credits

This package was built by CNJ Digital.

Version 3 License

Version 3 is a commercial addon for Statamic. It is open source but not free to use. You can purchase a license at Statamic Marketplace.

Version 2 and 1 License

Version 2 and 1 were licensed under the MIT License.