Skip to content

NoelDeMartin/laravel-semantic-seo

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

Laravel Semantic SEO Build Status

Use this package to define Semantic SEO information through meta tags and structure data types.

Installation

Install using composer:

composer require noeldemartin/laravel-semantic-seo

The package will be automatically loaded using Laravel's package discovery.

(If you're using a Laravel version before 6.0, run composer require noeldemartin/laravel-semantic-seo:0.0.1 instead)

Usage

This package helps to scaffold Semantic HTML for a website defining two things:

  • Meta tags: The most common approach to define semantic information in a website is to include meta tags with specific information of the current page. This is how most social networks create a preview when sharing links, for example Twitter Cards or Facebook Open Graph. Search engines also use some of these tags to format how a link appears on the search results.

  • Types: In order to provide richer semantics, types can be defined for specific use cases such as Blog Posts, Persons, Web Applications, etc. The type system used in this package provides schema.org schemas that are a common way of defined Structured Data. One advantage of defining this richer data, is that meta tags can be inferred from this types and information doesn't need to be repeated.

The markup generated with this package should be placed on the head element. A Blade directive named semanticSEO is included with this package:

<html>
    <head>
        @semanticSEO

        // Other tags in head such as css or js assets
    </head>
    <body>
        // Page content
    </body>
</html>

In order to define Types and Meta tags, use the SemanticSEO facade.

Using Types

Not all types are available with this package, but most common are. For example, you could define the information for a WebSite schema in your page as such:

SemanticSEO::website()
    ->url(route('home'))
    ->name('My Website');

You can place this code wherever you want, for example on the Controller handler methods.

Types automatically add meta tags that make sense, for example the code above would generate the following markup:

<title>My Website</title>
<link rel="canonical" href="https://mywebsite.com">
<meta property="og:type" content="website">
<meta property="og:title" content="My Website">
<meta property="og:url" content="https://mywebsite.com">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="My Website">
<meta name="twitter:url" content="https://mywebsite.com">
<script type="application/ld+json">
    {
        "@context":"http:\/\/schema.org",
        "url":"https:\/\/mywebsite.com",
        "name":"My Website",
        "@type":"WebSite"
    }
</script>

Other than the available types, any new types can be used with the method is like so:

SemanticSEO::is(MyType::class)
    ->myAttribute('foobar');

To see more examples of what's available and how to use existing types, take a look to the tests in TypesTests.php file under /tests/Unit.

Using Meta tags

Some times it is necessary to define meta tags explicitly. It's also possible that for some reason you don't want to use types, in which case meta tags can be defined one by one:

SemanticSEO::meta('title', 'My Website');
SemanticSEO::meta('description', 'My Website is awesome');

Keep in mind that this package is aware of some special meta tags, for example using the "title" meta tag will actually render as a <title> tag and not <meta>. Multiple meta tags can also be defined at once (for example, if you keep the content of this tags in translation files):

SemanticSEO::meta([
    'title' => trans('seo.title'),
    'description' => trans('seo.description'),
]);

To see more examples of what's available and how to use existing meta tags, take a look to the tests in MetaTagsTests.php file under /tests/Unit.

Some other special meta tags are the following:

Robots

To hide one page from crawlers, call SemanticSEO::hide() which will generate:

<meta name="robots" content="noindex, nofollow">

A middleware has also been registered in case this wants to be called from the routes file (for example, when using the view short-hand to define routes):

Route::view('secret', 'secret')->middleware('semantic-seo:hide');

Sitemap and RSS

To define sitemap or rss xml locations (this could be placed in a Service Provider to prevent calling this in every controller):

SemanticSEO::rss(url('blog/rss.xml'), 'My RSS Feed');
SemanticSEO::sitemap(url('sitemap.xml'), 'My Sitemap');

Which will generate:

<link rel="alternate" type="application/rss+xml" title="My RSS Feed" href="https://mywebsite.com/blog/rss.xml">"
<link rel="sitemap" type="application/xml" title="My Sitemap" href="https://mywebsite.com/sitemap.xml">"

Canonical url

The canonical location of the page is automatically generated for every page, this can be disabled setting it as false (as well as any meta overriding by Types):

SemanticSEO::canonical(false);

Social networks

Some short-hands are also defined for twitter and open graph, which will automatically include twitter: and og: prefixes:

SemanticSEO::twitter('title', 'Twitter title');
SemanticSEO::openGraph('title', 'Open Graph title');

Which will generate:

<meta name="twitter:title" content="Twitter title">
<meta property="og:title" content="Open Graph title">

Extending

The basic functionallity for this package is completed, but it's lacking some type definitions. They are, however, very easy to add. In order to create a new type (or extend an existing one) three things need to be done:

  • Extend one existing type under NoelDeMartin\SemanticSEO\Types namespace. If none appropiate exists, use Thing.
  • If the name of your class is not the name of the type (for example, if you are defining a class to reuse the arguments), override getType method and return the appropriate name.
  • If you want to automatically add meta tags when using a type, override the beforeRender method.
  • If you want to add extra field attributes, override the getAttributeDefinitions method.

Examples on how to do this can be found under the /src/Types folder, since existing classes already use this approach. I encourage you to create PRs adding extensions that live within the schema.org specification. The hierarchy of types together with their fields can be found here.

About

Provide utilities to add Semantic SEO to Laravel Applications

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages