Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 1.69 KB

README.md

File metadata and controls

54 lines (45 loc) · 1.69 KB

Super Simple SEO for OctoberCMS

How to use

Installation
  1. Install the plugin to your plugins folder under plugins/jd/seo
  2. In the head tag of your website insert the component {% component 'seoTags' %}
Controlling the output

There are 1 of 2 ways you can control the output of each tag.

  1. By using the default CMS Page meta title or description field
  2. Programatically defining the tags in your own plugin or CMS page
Programmatically controlling the SEO tags

Programmatically controlling your output will override a pages meta title and description fields.

use JD\SEO\SEO;

...

public function onRun()
{
    SEO::meta()->title($title)
        ->description($description)
        // Google / Schema.org tags
        ->schema([
            'name' => $title,
            'description' => $description,
            'image' => $image,
        ])
        // Twitter tags
        ->twitter([
            'title' => $title,
            'description' => $description,
            'image' => $image,
            'url' => 'https://my-awesome-site.com',
        ])            
        // OpenGraph tags
        ->og([
            'site_name' => 'My Awesome site',
            'url' => 'https://my-awesome-site.com',
            'title' => $title,
            'description' => $description,
            'image' => $image,
        ])
        ->keywords(['awesome', 'page'])
    ;
}

This will output...

<title>My awesome page</title>
<meta name="description" content="This is my awesome page description." />
<meta name="keywords" content="awesome, page" />