Socket
Socket
Sign inDemoInstall

gatsby-plugin-react-helmet-canonical-urls

Package Overview
Dependencies
861
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

gatsby-plugin-react-helmet-canonical-urls

Add canonical links to HTML pages Gatsby generates using React Helmet.


Version published
Maintainers
1
Weekly downloads
9,429
decreased by-3.5%

Weekly downloads

Readme

Source

gatsby-plugin-react-helmet-canonical-urls

This can be use as a drop in replacement of gatsby-plugin-canonical-urls.

Add canonical links to HTML pages Gatsby generates using react helmet.

This implementation is primarily helpful for distinguishing between https/http, www/no-www but could possibly be extended to help with when sites add multiple paths to the same page.

Motivation

gatsby-plugin-canonical-urls and gatsby-plugin-react-helmet are plugins that do not always play well together. The first one always inserts a default canonical url, but doesn't allow to override that value in an easy way. When trying to use react helmet to override gatsby-plugin-canonical-urls default url, you will end up with two canonical tags.

This plugin, as writes the default canonical url using react helmet, allows to override default canonical url just using the standard react helmet api.

Install

npm install --save gatsby-plugin-react-helmet gatsby-plugin-react-helmet-canonical-urls

How to use

// In your gatsby-config.js
plugins: [
  `gatsby-plugin-react-helmet`,
  {
    resolve: `gatsby-plugin-react-helmet-canonical-urls`,
    options: {
      siteUrl: `https://www.example.com`,
    },
  },
]

With the above configuration, the plugin will add to the head of every HTML page a rel=canonical e.g.

<link rel="canonical" href="http://www.example.com/about-us/" />

Additional options:

  • exclude (Array of string or RegExp, default undefined): exclude pages from being added a canonical url. Useful when combining with other SEO-related meta tags like noindex. (Urls should be listed without trailing slash)
  • noTrailingSlash (default false): it will remove the trailing slash from canonical link. Use this option if you use gatsby-plugin-remove-trailing-slashes
  • noHash (default false): remove hash from the canonical link.
  • noQueryString (default false): remove query from the canonical link.

Keywords

FAQs

Last updated on 01 Dec 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc