8.0 KiB
astro-redirect-from
🎯 Set redirect urls in your frontmatter within your Astro site's Markdown files. Mimics the behavior of jekyll-redirect-from and gatsby-redirect-from.
Allows you to manage redirects directly from your Markdown files' frontmatter.
Table of Contents
Imagine you've just revamped your blog, and some of your old URLs have changed. You don't want to lose the SEO juice, nor do you want to leave your readers with broken links. This is where redirects come into play. But managing redirects can be cumbersome, especially if you have to do it manually or through server configurations.
This plugin automates this process by reading the redirect_from field in the frontmatter of your Markdown files and updating Astro's configuration to handle these redirects automatically.
How it Works
By adding a redirect_from list in your Markdown frontmatter, the plugin integrates these redirects into Astro's redirects configuration automatically, whether you're running the development server or building your project.
The plugin operates during the astro:config:setup lifecycle hook. It scans all Markdown files for the redirect_from key and updates Astro's configuration using updateConfig(). This ensures that any existing redirects are merged with new ones generated by the plugin.
Astro takes over from there, handling the redirects based on your site's build mode and in combination with any other integrations you might be using:
For statically-generated sites with no adapter installed, this will produce a client redirect using a
<meta http-equiv="refresh">tag and does not support status codes.When using SSR or with a static adapter in
output: staticmode, status codes are supported. Astro will serve redirectedGETrequests with a status of301and use a status of308for any other request method. Astro Configuration Reference: redirects
The plugin is designed to work with various Astro hosting integrations, most of them generate further redirect files in the places they require so this plugin works in combination with them:
- Netlify
- Vercel
- Cloudflare
- S3
Because Astro integrations are run in the order they are defined in the integrations array, this plugin should come before any other integrations which make use of the redirects config.
Prerequisites
The plugin is designed to work without configuration, especially if your project aligns with Astro's default settings.
- Requires Astro v3 (v2 probably works too, but is not tested)
- Markdown files should be in a directory (default is
src/pages/) - Slugs are extracted either from the frontmatter or the file/folder path
Installation
cd yourproject/
# Using NPM
npx astro add astro-redirect-from
# Using Yarn
yarn astro add astro-redirect-from
# Using PNPM
pnpm astro add astro-redirect-from
If installing manually:
npm i astro-redirect-from
Then load the plugin in your Astro config file:
import { defineConfig } from 'astro/config'
import redirectFrom from 'astro-redirect-from'
export default defineConfig({
// ...
integrations: [
// make sure this is listed before any
// hosting integration
redirectFrom()
]
// ...
)}
That's it. Your redirects will be automatically added the next time you run astro dev or astro build. If any of them have a redirect_from field, that is.
Options
Options are all optional and can be passed in Astro's config file:
import { defineConfig } from 'astro/config'
import redirectFrom from 'astro-redirect-from'
import { getMySlug } from './your-slug-function'
export default defineConfig({
// ...
integrations: [
redirectFrom({
contentDir: './content',
getSlug: getMySlug
})
]
// ...
)}
contentDir: string
Default: src/pages/
Specify a different directory for your Markdown files, relative to the project root.
getSlug: (filePath: string) => string
Default: getSlugFromFilePath(), see below
If you need a custom slug structure, pass a function to construct your slug from the file path.
If you use a slug field in your frontmatter, this will be preferred by the plugin and passing any getSlug function will have no effect in that case.
The default function is a great starting point:
function getSlugFromFilePath(filePath: string) {
const parsedPath = path.parse(filePath)
let slug
// construct slug as full path from either:
// - folder name if file name is index.md, or
// - file name
if (parsedPath.base === 'index.md' || parsedPath.base === 'index.mdx') {
slug = `/${parsedPath.dir}`
} else {
slug = `/${parsedPath.dir}/${parsedPath.name}`
}
return slug
}
Usage
In your Markdown file's frontmatter, use the key redirect_from followed by a list.
---
redirect_from:
- /old-url-1
- /old-url-2
- /old-url-3.html
---
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
Copyright (c) 2023 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:
krema.eth