mirror of https://github.com/kremalicious/gatsby-redirect-from.git synced 2024-12-22 09:13:20 +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 7a1978ce01 add codeclimate badge		2018-08-30 01:22:57 +02:00
.codeclimate.yml	initial commit 🍷	2018-08-30 01:11:52 +02:00
.editorconfig	initial commit 🍷	2018-08-30 01:11:52 +02:00
.eslintrc	initial commit 🍷	2018-08-30 01:11:52 +02:00
.gitignore	initial commit 🍷	2018-08-30 01:11:52 +02:00
.npmignore	initial commit 🍷	2018-08-30 01:11:52 +02:00
.travis.yml	initial commit 🍷	2018-08-30 01:11:52 +02:00
gatsby-node.js	initial commit 🍷	2018-08-30 01:11:52 +02:00
index.js	initial commit 🍷	2018-08-30 01:11:52 +02:00
LICENSE	initial commit 🍷	2018-08-30 01:11:52 +02:00
package.json	fix test	2018-08-30 01:20:11 +02:00
README.md	add codeclimate badge	2018-08-30 01:22:57 +02: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.

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.

Prerequisites

Gatsby v2
only parses Markdown files delivered from gatsby-transformer-remark
slug on fields

Installation

cd yourproject/
npm i gatsby-redirect-from

Then load the plugin from your gatsby-config.js:

plugins: ['gatsby-redirect-from']

Usage

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

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

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