A Gatsby plugin to support SEO, built-on top of the Gatsby Head API. No react-helmet required.
It is intended to be used with the Gatsby Head API.
Support for the Gatsby Head API was added in gatsby@4.19.0
.
// gatsby-config.ts
import { type GatsbyConfig } from 'gatsby';
const config: GatsbyConfig = {
siteMetadata: {
siteUrl: 'https://my-hoempage.com',
title: 'My Homepage',
description: 'This is my hoempage',
},
plugins: [
'gatsby-plugin-head-seo',
],
};
The <HeadSeo />
use siteMetadata you defines in gatsby-config.
It automatically builds basic meta tags for title, description, and canonical url for the page.
// in the page
import { type HeadProps } from 'gatsby';
import { HeadSeo } from 'gasby-plugin-head-seo/src';
export function Head({ location }: HeadProps) {
return (
<HeadSeo location={location} />
);
}
You can overrides the passing properties.
// in the page
import { type HeadProps } from 'gatsby';
import { HeadSeo } from 'gasby-plugin-head-seo/src';
export function Head({ location }: HeadProps) {
return (
<HeadSeo
location={location}
title="This is New Title"
/>
);
}
There are utility components for Open Graph and Twitter Card.
Twitter Card indirectly reference the Open Graph standard, so I recommend always using them together.
// in the page
import { type HeadProps } from 'gatsby';
import { HeadSeo, OpenGraph, TwitterCard, Facebook } from 'gasby-plugin-head-seo/src';
export function Head({ location }: HeadProps) {
return (
<HeadSeo location={location}>
{({ url, title, description }) => (
<>
<OpenGraph
locale="ko"
og={{
type: 'website',
url,
title,
description,
}}
/>
<TwitterCard
card={{
type: 'summary'
site: '@handle',
title,
description,
}}
/>
<Facebook appId="my_facebook_app_id" />
</>
)}
</HeadSeo>
);
}
There are utilities for robots meta tags.
// in the page
import { type HeadProps } from 'gatsby';
import { HeadSeo, Robots } from 'gasby-plugin-head-seo/src';
export function Head({ location }: HeadProps) {
return (
<HeadSeo location={location}>
<Robots noindex />
<Robots name="googlebot" noSnippet />
<Robots name="googlebot-news" maxSnippet={20} />
</HeadSeo>
);
}
There are utilities for JSON-LD markup. It refers to the schema.org standard, and some extensions for Google Search's rich content schema.
import {
// schema.org standard schema
ArticleJsonLd,
BlogJsonLd,
BlogPostJsonLd,
BookJsonLd,
BreadcrumbListJsonLd,
CourseJsonLd,
FAQPageJsonLd,
JobPostingJsonLd,
LocalBusinessJsonLd,
ProductJsonLd,
WebSiteJsonLd, // Supports Google's Sitelinks Search Box extension
// extensions
SocialProfileJsonLd, // Person or Organization
} from 'gasby-plugin-head-seo/src/jsonld';
See code for more detail.
<HeadSeo location={location}>
{({ title: siteTitle }) => (
<HeadSeo location={location} title={`Category | ${siteTitle}`}>
{({ title: categoryTitle }) => (
<title>{`Content | ${categoryTitle}`}</title>
// So the result will be `Content | Category | Site`
)}
</HeadSeo>
)}
</HeadSeo>
FYI, this plugin uses gatsby-plugin-dedupe-head for deduplication of tags.
This plugin was inspired by https://github.com/ifiokjr/gatsby-plugin-next-seo, which was originally forked from next-seo
MIT