mirror of https://github.com/kremalicious/gatsby-redirect-from.git synced 2024-10-31 23:35:30 +01:00

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

Go to file

Matthias Kretschmann acf2414352 Merge pull request #153 from kremalicious/dependabot/npm_and_yarn/babel/core-7.14.2 Bump @babel/core from 7.13.10 to 7.14.2		2021-05-23 10:56:14 +02:00
.github	fix CI run on tag push	2021-02-01 00:28:30 +01:00
src	docs updates	2020-05-22 17:05:21 +02:00
.babelrc	add prettier	2019-06-11 00:27:06 +02:00
.eslintrc	fix prettier on Windows	2021-01-31 23:52:30 +01:00
.gitignore	package updates	2020-07-02 19:56:59 +02:00
.npmignore	initial commit 🍷	2018-08-30 01:11:52 +02:00
.prettierrc	cleanup	2021-02-01 00:06:30 +01:00
CHANGELOG.md	Release 0.3.0	2021-02-01 00:23:36 +01:00
LICENSE	initial commit 🍷	2018-08-30 01:11:52 +02:00
package-lock.json	Merge pull request #153 from kremalicious/dependabot/npm_and_yarn/babel/core-7.14.2	2021-05-23 10:56:14 +02:00
package.json	Bump eslint-config-prettier from 7.2.0 to 8.1.0	2021-03-01 04:02:41 +00:00
README.md	add npm publish job	2021-02-01 00:18:54 +01:00

README.md

gatsby-redirect-from

🎯 Set redirect urls in your YAML frontmatter within your Gatsby site's Markdown files. Mimics the behavior of jekyll-redirect-from. https://kremalicious.com/gatsby-redirect-from/

By adding a redirect_from list of URLs to your Markdown file's YAML frontmatter, this plugin creates client-side redirects for all of them at build time, with Gatsby's createRedirect used under the hood.

By combining this plugin with gatsby-plugin-meta-redirect, you get simple server-side redirects from your redirect_from lists out of the box. You can also combine it with any other plugin picking up Gatsby createRedirect calls to get proper SEO-friendly server-side redirects for your hosting provider.

Table of Contents

Prerequisites
Installation
Usage
Documentation
Plugin Development
Changelog
License

Prerequisites

Gatsby v2
Markdown files delivered from gatsby-transformer-remark
slug on allMarkdownRemark.edges.node.fields

Installation

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

Then load the plugin along with e.g. 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.

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: trailing slashes are required
---

Documentation

More explanations and options, all about server-side redirects, and additional plugins which can be used in combination with gatsby-redirect-from.

Documentation →

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

Changelog

See CHANGELOG.md.

License

The MIT License

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