Skip to content
🎯 Set redirect urls in your YAML frontmatter within your Gatsby site's Markdown files. Mimics the behavior of jekyll-redirect-from.
Branch: master
Clone or download
Latest commit 79b7c56 Jun 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Name query and change reference to query result Jan 9, 2019
.babelrc
.editorconfig initial commit 🍷 Aug 29, 2018
.eslintrc add prettier Jun 10, 2019
.gitignore babelify build Aug 30, 2018
.npmignore
.prettierrc add prettier Jun 10, 2019
.travis.yml add prettier Jun 10, 2019
CHANGELOG.md Release 0.2.1 Jun 10, 2019
LICENSE initial commit 🍷 Aug 29, 2018
README.md simplify release-it tasks, add changelog Jun 10, 2019
package.json Release 0.2.1 Jun 10, 2019

README.md

gatsby-redirect-from

npm package Build Status Maintainability Greenkeeper badge

🎯 Set redirect urls in your YAML frontmatter within your Gatsby site's Markdown files. Mimics the behavior of jekyll-redirect-from.

By adding a list of urls to the YAML frontmatter, this plugin creates redirects for all of them at build time. It uses Gatsby's createRedirect under the hood.

Table of Contents


Prerequisites

Plugin assumes the default setup from gatsby-starter-blog, with Markdown files processing by gatsby-transformer-remark and adding a field slug for each file node. Head over to gatsby-starter-blog's gatsby-node.js file to see how this is done.

If this does not fit your setup, you can configure the default query being used.

Installation

cd yourproject/
npm i gatsby-redirect-from gatsby-plugin-meta-redirect

Then load the plugin along with gatsby-plugin-meta-redirect from your gatsby-config.js:

plugins: [
  'gatsby-redirect-from',
  'gatsby-plugin-meta-redirect' // make sure this is always the last one
]

That's it. See Usage.

Server Rendering

Gatsby's createRedirect only creates client-side redirects, so further integration is needed to get server redirects too. Which is highly dependent on your hosting, if you want to have the proper HTML status codes like 301, Apache needs .htaccess rules for that, nginx rewrite rules, S3 RoutingRules and so on.

One simple way, as suggested in installation, is to use gatsby-plugin-meta-redirect to generate static HTML files with a <meta http-equiv="refresh" /> tag for every createRedirect call. So it works out of the box with this plugin without further adjustments.

This way is the most compatible way of handling redirects, working with pretty much every hosting provider. Only catch: it's only for usability, no SEO-friendly 301 redirect is set anywhere.

Usage

In your Markdown file's YAML frontmatter, use the key redirect_from followed by a list:

---
title: Aperture File Types
redirect_from:
  - /new-goodies-aperture-file-types-icons/
  - /goodie-updated-aperture-file-types-v11/
  - /aperture-file-types-v12-released/
  - /2008/04/aperture-file-types/
  # note: forward slashes are required
---

Options

Plugin does not require to be configured but some additional customization options are available:

Option Default Description
query allMarkdownRemark Modify the query being used to get the frontmatter data. E.g. if you use MDX, set allMdx here.

Add options to the plugins's configuration object in gatsby-config.js like so:

plugins: [
  {
    resolve: 'gatsby-redirect-from',
    options: {
      query: 'allMdx'
    }
  }
  'gatsby-plugin-meta-redirect' // make sure this is always the last one
]

Plugin Development

npm i
npm start

# production build
npm run build

# publishing to npm & GitHub releases
# uses https://github.com/webpro/release-it
npm run release
npm run release minor
npm run release major

License

The MIT License

Copyright (c) 2019 Matthias Kretschmann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Made with β™₯ by Matthias Kretschmann (@kremalicious)

Say thanks with BTC: 35UUssHexVK48jbiSgTxa4QihEoCqrwCTG

Say thanks with ETH: 0x04354F554536DA108726829207958d3E277f0210

You can’t perform that action at this time.