Have you seen the new Next.js newsletter?

Useful Tools

dub recently launched a useful Free UTM builder! You can use it here

Next SEO

npm

Next SEO is a plugin that makes managing your SEO easier in Next.js projects.

Pull requests are very welcome. Also make sure to check out the issues for feature requests if you are looking for inspiration on what to add.

Feel like supporting this free plugin?

It takes a lot of time to maintain an open source project so any small contribution is greatly appreciated.

Coffee fuels coding ☕️

next-seo.wallet (ERC20 & SOL)

Note on app directory

This note is only relevant if using the app directory.

For standard meta data (e.g., <meta>, <title>) then it is highly recommended that you use the built-in generateMetaData method. You can check out the docs here

For JSON-LD then, the only change needed is to add useAppDir={true} to the JSON-LD component in use. You should add use this component in your page.js and NOT your head.js.

<ArticleJsonLd
  useAppDir={true}
  url="https://example.com/article"
  title="Article headline" <- required for app directory
  />

If you are using pages directory then NextSeo is exactly what you need for your SEO needs!

Usage
Open Graph
- Open Graph Examples
  - Basic
  - Video
  - Audio
  - Article
  - Book
  - Profile
JSON-LD
- JSON-LD Security
- Handling multiple instances
- Article
- Breadcrumb
- Blog
- Campground
- Recipe
- Sitelinks Search Box
- Course
- Dataset
- Corporate Contact
- FAQ Page
- How-to
- Job Posting
- Local Business
- Logo
- Product
- Social Profile
- News Article
- Park
- Video
- VideoGame
- Event
- Q&A
- Collection Page
- Profile page
- Carousel
  - Default (Summary List)
  - Course
  - Movie
  - Recipe
  - Custom
- Software App
- Organization
- Brand
- WebPage
- Image Metadata
Contributors

Usage

NextSeo works by including it on pages where you would like SEO attributes to be added. Once included on the page, you pass it a configuration object with the page's SEO properties. This can be dynamically generated at a page level, or in some cases, your API may return an SEO object.

Setup

First, install it:

npm install next-seo

yarn add next-seo

Add SEO to Page

Using Next.js app directory introduced in Next.js 13?

If you are using the Next.js app directory, then it is highly recommended that you use the built-in generateMetaData method. You can check out the docs here

If you are using the pages directory, then NextSeo is exactly what you need for your SEO needs!

Then, you need to import NextSeo and add the desired properties. This will render out the tags in the <head> for SEO. At a bare minimum, you should add a title and description.

Example with just title and description:

import { NextSeo } from 'next-seo';

const Page = () => (
  <>
    <NextSeo
      title="Simple Usage Example"
      description="A short description goes here."
    />
    <p>Simple Usage</p>
  </>
);

export default Page;

But NextSeo gives you many more options that you can add. See below for a typical example of a page.

Typical page example:

import { NextSeo } from 'next-seo';

const Page = () => (
  <>
    <NextSeo
      title="Using More of Config"
      description="This example uses more of the available config options."
      canonical="https://www.canonical.ie/"
      openGraph={{
        url: 'https://www.url.ie/a',
        title: 'Open Graph Title',
        description: 'Open Graph Description',
        images: [
          {
            url: 'https://www.example.ie/og-image-01.jpg',
            width: 800,
            height: 600,
            alt: 'Og Image Alt',
            type: 'image/jpeg',
          },
          {
            url: 'https://www.example.ie/og-image-02.jpg',
            width: 900,
            height: 800,
            alt: 'Og Image Alt Second',
            type: 'image/jpeg',
          },
          { url: 'https://www.example.ie/og-image-03.jpg' },
          { url: 'https://www.example.ie/og-image-04.jpg' },
        ],
        siteName: 'SiteName',
      }}
      twitter={{
        handle: '@handle',
        site: '@site',
        cardType: 'summary_large_image',
      }}
    />
    <p>SEO Added to Page</p>
  </>
);

export default Page;

A note on Twitter Tags

Props cardType, site, handle are equivalent to twitter:card, twitter:site, twitter:creator. Documentation can be found here.

Twitter will read the og:title, og:image and og:description tags for their card. next-seo omits twitter:title, twitter:image and twitter:description to avoid duplication.

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

Default SEO Configuration

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

To achieve this, you will need to create a custom <App>. In your pages directory, create a new file, _app.js. See the Next.js docs here for more info on a custom <App>.

Within this file you will need to import DefaultSeo from next-seo and pass it props.

Here is a typical example:

import App, { Container } from 'next/app';
import { DefaultSeo } from 'next-seo';

// import your default seo configuration
import SEO from '../next-seo.config';

export default class MyApp extends App {
  render() {
    const { Component, pageProps } = this.props;
    return (
      <Container>
        <DefaultSeo
          openGraph={{
            type: 'website',
            locale: 'en_IE',
            url: 'https://www.url.ie/',
            siteName: 'SiteName',
          }}
          twitter={{
            handle: '@handle',
            site: '@site',
            cardType: 'summary_large_image',
          }}
        />
        <Component {...pageProps} />
      </Container>
    );
  }
}

To work properly, DefaultSeo should be placed above (before) Component due to the behavior of Next.js internals.

Alternatively, you can also create a config file to store default values such as next-seo.config.js

export default {
  openGraph: {
    type: 'website',
    locale: 'en_IE',
    url: 'https://www.url.ie/',
    siteName: 'SiteName',
  },
  twitter: {
    handle: '@handle',
    site: '@site',
    cardType: 'summary_large_image',
  },
};

<details><summary>or like this, if you are using TypeScript</summary> <p>

import { DefaultSeoProps } from 'next-seo';

const config: DefaultSeoProps = {
  openGraph: {
    type: 'website',
    locale: 'en_IE',
    url: 'https://www.url.ie/',
    siteName: 'SiteName',
  },
  twitter: {
    handle: '@handle',
    site: '@site',
    cardType: 'summary_large_image',
  },
};

export default config;

</p> </details>

import at the top of _app.js

import SEO from '../next-seo.config';

and the DefaultSeo component can be used like this instead

<DefaultSeo {...SEO} />

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

Note that Container is deprecated in Next.js v9.0.4 so you should replace that component here with React.Fragment on this version and later - see here

NextSeo 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
`defaultTitle`	string	If no title is set on a page, this string will be used instead of an empty `titleTemplate` More Info
`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
`robotsProps`	Object	Set the more meta information for the `X-Robots-Tag` 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. Expects array of objects with the shape: `{ hrefLang: string, href: string }`
`themeColor`	string	Indicates a suggested color that user agents should use to customize the display of the page or of the surrounding user interface. Must contain a valid CSS color
`additionalMetaTags`	array	Allows you to add a meta tag that is not documented here. More Info
`additionalLinkTags`	array	Allows you to add a link 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 language_TERRITORY. Default is en_US.
`openGraph.siteName`	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 = 'Next SEO | %s';
// outputs: Next SEO | This is my title

title = 'This is my title';
titleTemplate = '%s | Next SEO';
// outputs: This is my title | Next SEO

Default Title

title = undefined;
titleTemplate = 'Next SEO | %s';
defaultTitle = 'Next SEO';
// outputs: Next SEO

No Index

Setting this to true will set noindex,follow (to set nofollow, please refer to

next-seo

Next SEO

Table of Contents

Usage

Setup

Add SEO to Page

Default SEO Configuration

NextSeo Options

Title Template

Default Title

No Index

编辑推荐精选

TRAE编程

蛙蛙写作

问小白

Transly

讯飞智文

讯飞星火

Spark-TTS

咔片PPT

讯飞绘文

材料星

探索AI的无限可能

推荐工具精选

TRAE编程

豆包

讯飞文书

讯飞绘文

讯飞绘镜

阿里绘蛙

咔片PPT

AI云服务特惠

火山引擎

阿里云

腾讯云

华为云

百度智能云

AWS

关注微信公众号