Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby-plugin-pagemeta

A GatsbyJS plugin to use comments as page metadata.

Usage

yarn add gatsby-plugin-pagemeta

Add plugin to the gatsby-config.js

plugins: ['gatsby-plugin-pagemeta']

See types for more detail.

Example

// in pages/my-page.js

// @pageMeta:title My Page
// @pageMeta:description An example page

const MyPage: React.FC = () => {
  // ...
};

export default MyPage;

This plugin extracts the metadata from comments, so you can query them from otherside like

query Navigation {
  allSitePage {
    nodes {
      path
      context {
        pageMeta {
          title
          description
        }
      }
    }
  }
}

License

MIT

© 2023 Gatsby, Inc.