npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jigar-johnstonhowse/plugin-seo

v1.0.17

Published

SEO plugin for Payload CMS

Downloads

7

Readme

Payload SEO Plugin

NPM

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

Core features:

  • Adds a meta field to every SEO-enabled collection or global. It:
    • includes title, description, and image subfields
    • auto-generates meta data from your document's content
    • displays hints and indicators to help content editors
    • renders a snippet of what a search engine might display
    • soon will 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.

  • uploadsCollection : string | optional

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

  • tabbedUI : boolean | optional

    Displays meta fields as tabs using Payload's Tabs Field. Defaults to false.

  • generateTitle : method | optional

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

    seo({
      ...
      generateTitle: ({ 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: ({ 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: ({ 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: ({ doc, locale }) => `https://yoursite.com/${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 [email protected] 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