Need help with gatsby-plugin-next-seo?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ifiokjr
145 Stars 15 Forks MIT License 75 Commits 9 Opened issues

Description

Gatsby Plugin Next SEO is a plug in that makes managing your SEO easier in Gatsby projects.

Services available

!
?

Need anything else?

Contributors list

# 27,738
gesture...
React N...
TypeScr...
HTML
53 commits
# 1,633
ugui
unity3d
graysca...
fish-sh...
12 commits
# 397,967
Shell
cloudwa...
Amazon ...
TypeScr...
2 commits
# 661,193
blade
WordPre...
sage
TypeScr...
1 commit
# 159,129
HTML
TypeScr...
React
reactjs
1 commit
# 102,586
JavaScr...
1 commit
# 336,927
CSS
JavaScr...
tailwin...
gridsom...
1 commit

gatsby-plugin-next-seo

GitHub Actions Build Status npm All Contributors semantic-release

Gatsby Plugin SEO makes managing SEO easier in your Gatsby JS project. It fully supports server-side rendering (SSR) with site wide configuration available via the

gatsby-config.js
plugin options. SEO options can also be tweaked at any moment by importing the main
GatsbySeo
component and passing in the desired props.

This codebase was initially forked from the brilliant next-seo project and is now maintained separately.

Table of Contents

Usage

GatsbySeo
can be imported anywhere in your gatsby project. Once included you pass the configuration props with the page's SEO properties. A sitewide / default configuration can also be set via the plugin options in your
gatsby-config.js
file.

Setup

First, install the plugin and it's peer dependencies:

npm install --save gatsby-plugin-next-seo react-helmet-async

or

yarn add gatsby-plugin-next-seo react-helmet-async

react-helmet-async
is an required external dependency since it relies on the
React.Context
API which can cause problems when different versions of the same library interact.

Add Plugin to Gatsby Config

Add the following configuration to your

gatsby-config.js
file.
module.exports {
  // ...
  plugins: [
    // ...
    'gatsby-plugin-next-seo'
  ],
}

The plugin allows documented GatsbySeoPluginOptions to be set. See an example below.

Add SEO to Page

Then you need to import

GatsbySeo
and add the desired properties. This component render the tags in the
 for SEO on a per page basis. As a bare minimum, you should add a title and description.

Example with just title and description:

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Simple Usage

> );

But

GatsbySeo
gives you many more options that you can add. See below for a typical example for any given gatsby layout.

Typical page example:

import React, { FC } from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

const Layout: FC = ({ children }) => ( <>

{children}
> );

export default Layout;

A note on Twitter Tags

Twitter will read the

og:title
,
og:image
and
og:description
tags for their card.
gatsby-plugin-next-seo
omits
twitter:title
,
twitter:image
and
twitter:description
to avoid duplication.

Some tools may report this an error. See Issue #14

Default SEO Configuration in Gatsby Config

GatsbySeo
enables you to set the default SEO properties that will appear on all pages without needing to do include anything on them. You can also override these on a page by page basis if needed.

To achieve this, you will need to add the properties to your

gatsby-config.js
file when setting up the plugin.

Here is a typical example:

// gatsby-config.js

module.exports { plugins: [ { resolve: 'gatsby-plugin-next-seo', options: { openGraph: { type: 'website', locale: 'en_IE', url: 'https://www.url.ie/', site_name: 'SiteName', }, twitter: { handle: '@handle', site: '@site', cardType: 'summary_large_image', }, }, }, ], }

From now on all of your gatsby pages will have the defaults above applied.

GatsbySeo Options

| Property | Type | Description | | ---------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

titleTemplate
| string | Allows you to set default title template that will be added to your title More Info. | |
title
| string | Set the meta title of the page. | |
language
| string | Set the language of the current page. This is added to the html tag and can prevent this warning. | |
noindex
| boolean (default false) | Sets whether page should be indexed or not More Info. | |
nofollow
| boolean (default false) | Sets whether page should be followed or not More Info. | |
description
| string | Set the page meta description. | |
canonical
| string | Set the page canonical url. | |
mobileAlternate.media
| string | Set what screen size the mobile website should be served from. | |
mobileAlternate.href
| string | Set the mobile page alternate url. | |
languageAlternates
| array | Set the language of the alternate urls. The shape of the object should be:
{ hrefLang: string, href: string }
. | |
metaTags
| array | Allows you to add a meta tag that is not documented here. More Info. | |
twitter.cardType
| string | The card type, which will be one of
summary
,
summary_large_image
,
app
, or
player
. | |
twitter.site
| string | @username for the website used in the card footer. | |
twitter.handle
| string | @username for the content creator / author (outputs as
twitter:creator
). | |
facebook.appId
| string | Used for Facebook Insights, you must add a facebook app ID to your page to for it More Info. | |
openGraph.url
| string | The canonical URL of your object that will be used as its permanent ID in the graph. | |
openGraph.type
| string | The type of your object. Depending on the type you specify, other properties may also be required More Info | |
openGraph.title
| string | The open graph title, this can be different than your meta title. | |
openGraph.description
| string | The open graph description, this can be different than your meta description. | |
openGraph.images
| array | An array of images (object) to be used by social media platforms, slack etc as a preview. If multiple supplied you can choose one when sharing. See Examples | |
openGraph.videos
| array | An array of videos (object). | |
openGraph.locale
| string | The locale the open graph tags are marked up in. Of the format languageTERRITORY. Default is enUS. | |
openGraph.site_name
| string | If your object is part of a larger web site, the name which should be displayed for the overall site. | |
openGraph.profile.firstName
| string | Person's first name. | |
openGraph.profile.lastName
| string | Person's last name. | |
openGraph.profile.username
| string | Person's username. | |
openGraph.profile.gender
| string | Person's gender. | |
openGraph.book.authors
| string[] | Writers of the article. See Examples | |
openGraph.book.isbn
| string | The ISBN | |
openGraph.book.releaseDate
| datetime | The date the book was released. | |
openGraph.book.tags
| string[] | Tag words associated with this book. | |
openGraph.article.publishedTime
| datetime | When the article was first published. See Examples | |
openGraph.article.modifiedTime
| datetime | When the article was last changed. | |
openGraph.article.expirationTime
| datetime | When the article is out of date after. | |
openGraph.article.authors
| string[] | Writers of the article. | |
openGraph.article.section
| string | A high-level section name. E.g. Technology | |
openGraph.article.tags
| string[] | Tag words associated with this article. |

Title Template

Replaces

%s
with your title string
title = 'This is my title';
titleTemplate = 'Gatsby SEO | %s';
// outputs: Gatsby SEO | This is my title
title = 'This is my title';
titleTemplate = '%s | Gatsby SEO';
// outputs: This is my title | Gatsby SEO

No Index

Setting this to

true
will set
noindex,follow
(to set
nofollow
, please refer to
nofollow
). This works on a page by page basis. This property works in tandem with the
nofollow
property and together they populate the
robots
and
googlebot
meta tags.

Note: The

noindex
and the
nofollow
properties are a little different than all the others in the sense that setting them as a default does not work as expected. This is due to the fact Gatsby SEO already has a default of
index,follow
because
gatsby-plugin-next-seo
is a SEO plugin after all. So if you want to globally these properties, please see dangerouslySetAllPagesToNoIndex and dangerouslySetAllPagesToNoFollow.

Example No Index on a single page:

If you have a single page that you want no indexed you can achieve this by:

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

This page is no indexed

> );

/*

*/

dangerouslySetAllPagesToNoIndex

It has the prefix of

dangerously
because it will
noindex
all pages. As this is an SEO plugin, that is kinda dangerous action. It is not bad to use this, just please be sure you want to
noindex
EVERY page. You can still override this at a page level if you have a use case to
index
a page. This can be done by setting
noindex: false
.

No Follow

Setting this to

true
will set
index,nofollow
(to set
noindex
, please refer to
noindex
). This works on a page by page basis. This property works in tandem with the
noindex
property and together they populate the
robots
and
googlebot
meta tags.

Note: The

noindex
and the
nofollow
properties are a little different than all the others in the sense that setting them as a default does not work as expected. This is due to the fact Gatsby SEO already has a default of
index,follow
because
gatsby-plugin-next-seo
is a SEO plugin after all. So if you want to globally these properties, please see dangerouslySetAllPagesToNoIndex and dangerouslySetAllPagesToNoFollow.

Example No Follow on a single page:

If you have a single page that you want no indexed you can achieve this by:

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

This page is not followed

> );

/*

*/

dangerouslySetAllPagesToNoFollow

It has the prefix of

dangerously
because it will
nofollow
all pages. As this is an SEO plugin, that is kinda dangerous action. It is not bad to use this, just please be sure you want to
nofollow
EVERY page. You can still override this at a page level if you have a use case to
follow
a page. This can be done by setting
nofollow: false
.

|

noindex
|
nofollow
|
meta
content of
robots
,
googlebot
| | --------- | ---------- | --------------------------------------- | | -- | -- |
index,follow
(default) | | false | false |
index,follow
| | true | -- |
noindex,follow
| | true | false |
noindex,follow
| | -- | true |
index,nofollow
| | false | true |
index,nofollow
| | true | true |
noindex,nofollow
|

Twitter

Twitter will read the

og:title
,
og:image
and
og:description
tags for their card, this is why
gatsby-plugin-next-seo
omits
twitter:title
,
twitter:image
and
twitter:description
so not to duplicate.

Some tools may report this an error. See Issue #14

facebook

facebook={{
  appId: 1234567890,
}}

Add this to your SEO config to include the fb:app_id meta if you need to enable Facebook insights for your site. Information regarding this can be found in facebook's documentation

Canonical URL

Add this on a page per page basis when you want to consolidate duplicate URLs.

canonical = 'https://www.canonical.ie/';

Alternate

This link relation is used to indicate a relation between a desktop and a mobile website to search engines.

Example:

mobileAlternate={{
  media: 'only screen and (max-width: 640px)',
  href: 'https://m.canonical.ie',
}}
languageAlternates={[
  {
    hrefLang: 'de-AT',
    href: 'https://www.canonical.ie/de',
  },
  {
    hrefLang: 'es',
    href: 'https://www.canonical.ie/es',
}
]}

HTML Attributes

Add html attributes to the html tag with the

htmlAttributes
prop.

Example:

htmlAttributes={{
  prefix: "og: https://ogp.me/ns#",
}}

Meta Tags

This allows you to add any other meta tags that are not covered in the

config
.

content
is required. Then either
name
or
property
. (Only one on each)

Example:

metaTags={[{
  property: 'dc:creator',
  content: 'Jane Doe'
}, {
  name: 'application-name',
  content: 'GatsbySeo'
}]}

Invalid Examples:

These are invalid as they contain

property
and
name
on the same entry.
metaTags={[{
  property: 'dc:creator',
  name: 'dc:creator',
  content: 'Jane Doe'
}, {
  property: 'application-name',
  name: 'application-name',
  content: 'GatsbySeo'
}]}

Open Graph

For the full specification please check out the documentation.

Gatsby SEO currently supports:

Open Graph Examples

Basic Example

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Basic

> );

Video Example

Full info on http://ogp.me/

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Video Page SEO

> );

Article Example

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Article

> );

Book Example

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Book

> );

Profile Example

import React from 'react';
import { GatsbySeo } from 'gatsby-plugin-next-seo';

export default () => ( <>

Profile

> );

JSON-LD

Gatsby SEO has the ability to set JSON-LD a form of structured data. Structured data is a standardised format for providing information about a page and classifying the page content.

Google has excellent documentation on JSON-LD -> HERE

Override

Each (non-deprecated) JSON LD component provides a set of utility props to help you in the journey of setting up your your site for Search Engine Optimization and voice assistant support. However there are times when you will need more control, and for these situations there is an

overrides
prop available which allows you to manually override the schema type.

The following example would add a

datePublished
property to the JSON LD head script produced.
const OverrideCourseJsonLd = () => (
  
);

Currently, when using TypeScript, you must provide an

@type
property to the
overrides
prop. This may change in the future.

Article

import React from 'react';
import { ArticleJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Article JSON-LD

> );

News Article

This is simply a fancy wrapper around the

Article
component.

import React from 'react';
import { NewsArticleJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

News Article JSON-LD

> );

Blog Post

A utility component which wraps the

 component but is classified as a 
BlogPosting
.
import React from 'react';
import { BlogPostJsonLd } from 'gatsby-plugin-next-seo';
 *
export default () => (
  <>
    

Blog Post JSON-LD

> );

Breadcrumb

import React from 'react';
import { BreadcrumbJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Breadcrumb JSON-LD

> );

Required properties

| Property | Info | | --------------------------- | -------------------------------------------------------------------------------------------------------- | |

itemListElements
| | |
itemListElements.position
| The position of the breadcrumb in the breadcrumb trail. Position 1 signifies the beginning of the trail. | |
itemListElements.name
| The title of the breadcrumb displayed for the user. | |
itemListElements.item
| The URL to the webpage that represents the breadcrumb. |

Blog

Identifies the page as a blog and outlines the available posts.

import React from 'react';
import { BlogPostJsonLd } from 'gatsby-plugin-next-seo';
 *
export default () => (
  <>
    

Blog with several posts

> );

Book

The

Book
component makes search engines an entry point for discovering your books and authors. Users can then buy the books that they find directly from Search results.

An example feed is shown below.

import React from 'react';
import { CourseJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Book JSON-LD

> );

Speakable

The speakable schema.org property identifies sections within an article or webpage that are best suited for audio playback using text-to-speech (TTS).

Adding markup allows search engines and other applications to identify content to read aloud on voice assistant-enabled devices using TTS. Webpages with speakable structured data can use voice assistants to distribute the content through new channels and reach a wider base of users.

import React from 'react';
import { SpeakableJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Speakable JSON-LD

> );

FAQ

A Frequently Asked Question (FAQ) page contains a list of questions and answers pertaining to a particular topic. Properly marked up FAQ pages may be eligible to have a rich result on Search and voice assistants.

import React from 'react';
import { FAQJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

<h1>What?</h1>
<p>Stand</p>

<h1>How?</h1>
<p>Effort</p>

<h1>Why?</h1>
<p>Peace</p>

> );

| Property | Type | Description | | -------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------- | | questions | Question[] | An array of Question elements which comprise the list of answered questions that this FAQPage is about. |

Question Interface

The questions and answers for an FAQ Page.

| Property | Type | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------- | ----------------------------------------------------------------------------------------- | | answer | string | The answer to the question. There must be one answer per question. | | question | string | The full text of the question. For example, "How long does it take to process a refund?". |

Course

import React from 'react';
import { CourseJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Course JSON-LD

> );

Corporate Contact (Deprecated)

See the documentation with the reason for deprecation.

import React from 'react';
import { CorporateContactJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Corporate Contact JSON-LD

> );

Required properties

| Property | Info | | -------------------------- | ----------------------------------------------------------------------------------------------- | |

url
| Url to the home page of the company's official site. | |
contactPoint
| | |
contactPoint.telephone
| An internationalized version of the phone number, starting with the "+" symbol and country code | |
contactPoint.contactType
| Description of the purpose of the phone number i.e.
Technical Support
. |

Recommended ContactPoint properties

| Property | Info | | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | |

contactPoint.areaServed
|
String
or
Array
of geographical regions served by the business. Example
"US"
or
["US", "CA", "MX"]
| |
contactPoint.availableLanguage
| Details about the language spoken. Example
"English"
or
["English", "French"]
| |
gecontactPointo.contactOption
| Details about the phone number. Example
"TollFree"
|

Local Business

Local business is supported with a sub-set of properties.


Required properties

| Property | Info | | ------------------------- | -------------------------------------------------------------------------- | |

@id
| Globally unique ID of the specific business location in the form of a URL. | |
type
| LocalBusiness or any sub-type | |
address
| Address of the specific business location | |
address.addressCountry
| The 2-letter ISO 3166-1 alpha-2 country code | |
address.addressLocality
| City | |
address.addressRegion
| State or province, if applicable. | |
address.postalCode
| Postal or zip code. | |
address.streetAddress
| Street number, street name, and unit number. | |
name
| Business name. |

Supported properties

| Property | Info | | --------------- | ----------------------------------------------------------------------------------- | |

description
| Description of the business location | |
geo
| Geographic coordinates of the business. | |
geo.latitude
| The latitude of the business location | |
geo.longitude
| The longitude of the business location | |
images
| An image or images of the business. Required for valid markup depending on the type | |
telephone
| A business phone number meant to be the primary contact method for customers. | |
url
| The fully-qualified URL of the specific business location. |

NOTE:

Images are required for most of the types that you can use for

LocalBusiness
, if in doubt you should add an image. You can check your generated JSON over at Google's Structured Data Testing Tool

Logo

import React from 'react';
import { LogoJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Logo JSON-LD

> );

| Property | Info | | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | |

url
| The URL of the website associated with the logo. Logo guidelines | |
logo
| URL of a logo that is representative of the organization. |

Product

import React from 'react';
import { ProductJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Product JSON-LD

> );

Also available:

sku
,
gtin8
,
gtin13
,
gtin14
.

Valid values for

offers.itemCondition
:
  • https://schema.org/DamagedCondition
  • https://schema.org/NewCondition
  • https://schema.org/RefurbishedCondition
  • https://schema.org/UsedCondition

Valid values fro

offers.availability
:
  • https://schema.org/Discontinued
  • https://schema.org/InStock
  • https://schema.org/InStoreOnly
  • https://schema.org/LimitedAvailability
  • https://schema.org/OnlineOnly
  • https://schema.org/OutOfStock
  • https://schema.org/PreOrder
  • https://schema.org/PreSale
  • https://schema.org/SoldOut

More info on the product data type can be found here.

Social Profile (Deprecated)

See the documentation with the reason for deprecation.

import React from 'react';
import { SocialProfileJsonLd } from 'gatsby-plugin-next-seo';

export default () => ( <>

Social Profile JSON-LD

> );

Required properties

| Property | Info | | -------- | ----------------------------------------------------------------------------------------- | |

type
| Person or Organization | |
name
| The name of the person or organization | |
url
| The URL for the person's or organization's official website. | |
sameAs
| An array of URLs for the person's or organization's official social media profile page(s) |

Google Supported Social Profiles

  • Facebook
  • Twitter
  • Google+
  • Instagram
  • YouTube
  • LinkedIn
  • Myspace
  • Pinterest
  • SoundCloud
  • Tumblr

JsonLd

This is the base JSON component that allows you to create your own JSON LD components according to the spec.

Google Docs for Social Profile

API Docs

You can explore the api documentation here.

FAQ

Why did you choose
gatsby-plugin-next-seo
as the project name?

Unfortunately the better options gatsby-seo and gatsby-plugin-seo were already taken. As a result I've used gatsby-plugin-next-seo as a shout out to the original next-seo project from which this codebase has been forked.

Contributors

Thanks goes to these wonderful people (emoji key):


Ifiok Jr.

💻 📖

Harlley Oliveira

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.