/plugin-seo

The official SEO plugin for Payload

Primary LanguageTypeScript

Payload SEO Plugin

NPM

A plugin for Payload to auto-generate SEO meta data based on the content of your documents.

Core features:

  • Adds a meta field group to every SEO-enabled collection or global
  • Auto-generates meta data using your document's existing content
  • Displays hints and indicators to help content editor write effective meta
  • Renders a snippet of what a search engine might display
  • Extendable so you can define custom fields like og:title or json-ld
  • Soon will dynamic support variable injection

Installation

  yarn add @payloadcms/plugin-seo
  # OR
  npm i @payloadcms/plugin-seo

Basic Usage

In the plugins array of your Payload config, call the plugin with options:

import { buildConfig } from 'payload/config';
import seo from '@payloadcms/plugin-seo';

const config = buildConfig({
  collections: [
    {
      slug: 'pages',
      fields: []
    },
    {
      slug: 'media',
      upload: {
        staticDir: // path to your static directory,
      },
      fields: []
    }
  ],
  plugins: [
    seo({
      collections: [
        'pages',
      ],
      uploadsCollection: 'media',
      generateTitle: ({ doc }) => `Website.com — ${doc.title.value}`,
      generateDescription: ({ doc }) => doc.excerpt
    })
  ]
});

export default config;

Options

  • collections : string[] | optional

    An array of collections slugs to enable SEO. Enabled collections receive a meta field which is an object of title, description, and image subfields.

  • globals : string[] | optional

    An array of global slugs to enable SEO. Enabled globals receive a meta field which is an object of title, description, and image subfields.

  • fields Field[] | optional

    Append your own custom fields onto the meta field group. The following fields are provided by default:

    • title: text
    • description: textarea
    • image: upload (if an uploadsCollection is provided)
    • preview: ui

  • uploadsCollection : string | optional

    An upload-enabled collection slug, for the meta image to access.

  • tabbedUI : boolean | optional

    Appends an SEO tab onto your config using Payload's Tabs Field. If your collection is not already tab-enabled, meaning the first field in your config is not of type tabs, then one will be created for you called Content. Defaults to false.

    If you wish to continue to use top-level or sidebar fields with tabbedUI, you must not let the default Content tab get created for you (see the note above). Instead, you must define the first field of your config with type tabs and place all other fields adjacent to this one.

  • generateTitle : method | optional

    A function that allows you to return any meta title, including from document's content.

    seo({
  ...
  generateTitle: ({ ...docInfo, doc, locale }) => `Website.com — ${doc?.title?.value}`,
})

  • generateDescription : method | optional

    A function that allows you to return any meta description, including from document's content.

    seo({
  ...
  generateDescription: ({ ...docInfo, doc, locale }) => doc?.excerpt?.value
})

  • generateImage : method | optional

    A function that allows you to return any meta image, including from document's content.

    seo({
 ...
 generateImage: ({ ...docInfo, doc, locale }) => doc?.featuredImage?.value
})

  • generateURL : method | optional

    A function called by the search preview component to display the actual URL of your page.

    seo({
  ...
  generateURL: ({ ...docInfo, doc, locale }) => `https://yoursite.com/${collection?.slug}/${doc?.slug?.value}`
})

TypeScript

All types can be directly imported:

import {
  PluginConfig,
  GenerateTitle,
  GenerateDescription
  GenerateURL
} from '@payloadcms/plugin-seo/types';

Development

To actively develop or debug this plugin you can either work directly within the demo directory of this repo, or link your own project.

  1. Internal Demo

    This repo includes a fully working, self-seeding instance of Payload that installs the plugin directly from the source code. This is the easiest way to get started. To spin up this demo, follow these steps:

    1. First clone the repo
    2. Then, cd YOUR_PLUGIN_REPO && yarn && cd demo && yarn && yarn dev
    3. Now open http://localhost:3000/admin in your browser
    4. Enter username dev@payloadcms.com and password test

    That's it! Changes made in ./src will be reflected in your demo. Keep in mind that the demo database is automatically seeded on every startup, any changes you make to the data get destroyed each time you reboot the app.

  2. Linked Project

    You can alternatively link your own project to the source code:

    1. First clone the repo
    2. Then, cd YOUR_PLUGIN_REPO && yarn && cd demo && cp env.example .env && yarn && yarn dev
    3. Now cd back into your own project and run, yarn link @payloadcms/plugin-seo
    4. If this plugin using React in any way, continue to the next step. Otherwise skip to step 7.
    5. From your own project, cd node_modules/react && yarn link && cd ../react-dom && yarn link && cd ../../
    6. Then, cd YOUR_PLUGIN_REPO && yarn link react react-dom

    All set! You can now boot up your own project as normal, and your local copy of the plugin source code will be used. Keep in mind that changes to the source code require a rebuild, yarn build.

    You might also need to alias these modules in your Webpack config. To do this, open your project's Payload config and add the following:

    import { buildConfig } from "payload/config";

export default buildConfig({
  admin: {
    webpack: (config) => ({
      ...config,
      resolve: {
        ...config.resolve,
        alias: {
          ...config.resolve.alias,
          react: path.join(__dirname, "../node_modules/react"),
          "react-dom": path.join(__dirname, "../node_modules/react-dom"),
          payload: path.join(__dirname, "../node_modules/payload"),
          "@payloadcms/plugin-seo": path.join(
            __dirname,
            "../../payload/plugin-seo/src"
          ),
        },
      },
    }),
  },
});

Screenshots

image