https://github.com/kremalicious/astro-redirect-from
🎯 Set redirect urls in your frontmatter within your Astro site's Markdown files.
https://github.com/kremalicious/astro-redirect-from
astro astro-integration redirects
Last synced: 5 months ago
JSON representation
🎯 Set redirect urls in your frontmatter within your Astro site's Markdown files.
- Host: GitHub
- URL: https://github.com/kremalicious/astro-redirect-from
- Owner: kremalicious
- License: mit
- Created: 2023-09-22T11:57:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T04:23:59.000Z (6 months ago)
- Last Synced: 2025-04-20T11:34:21.694Z (6 months ago)
- Topics: astro, astro-integration, redirects
- Language: TypeScript
- Homepage: https://kremalicious.com/astro-redirect-from
- Size: 999 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://kremalicious.com/astro-redirect-from/)
# astro-redirect-from
[](https://www.npmjs.com/package/astro-redirect-from)
[](https://github.com/kremalicious/astro-redirect-from/actions/workflows/ci.yml)
[](https://codeclimate.com/github/kremalicious/astro-redirect-from/maintainability)
[](https://codeclimate.com/github/kremalicious/astro-redirect-from/test_coverage)
> 🎯 Set redirect urls in your frontmatter within your [Astro](https://astro.build) site's Markdown files. Mimics the behavior of [jekyll-redirect-from](https://github.com/jekyll/jekyll-redirect-from) and [gatsby-redirect-from](https://kremalicious.com/gatsby-redirect-from/).
>
> https://kremalicious.com/astro-redirect-from/
---
**Table of Contents**
- [Quick Start](#quick-start)
- [Documentation](#documentation)
- [Plugin Development](#plugin-development)
- [Testing](#testing)
- [Changelog](#changelog)
- [Sponsorship](#sponsorship)
- [License](#license)
---
## Quick Start
```bash
cd yourproject/
npx astro add astro-redirect-from
# or install manually
npm i astro-redirect-from
```
Then load the plugin in your Astro config file:
```js title="astro.config.mjs"
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()
]
// ...
)}
```
## [Documentation](https://kremalicious.com/astro-redirect-from/)
Find more explanations, all about server-side redirects, and learn about additional integrations which can be used in combination with astro-redirect-from.
- **[Documentation →](https://kremalicious.com/astro-redirect-from/)**
## Plugin Development
```bash
npm i
npm run dev
# production build
npm run build
# publishing to npm & GitHub releases
# uses https://github.com/webpro/release-it
npm run release
```
### Testing
```bash
npm run lint
npm run typecheck
# runs unit tests through vitest
npm run test:unit
# all of the above commands together
npm test
```
If linting errors are encountered, try to fix it automatically with:
```bash
npm run format
```
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
## Sponsorship
[](https://kremalicious.com/thanks)
[](https://github.com/sponsors/kremalicious)
## License
The MIT License
Copyright (c) 2024 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](https://matthiaskretschmann.com) ([@kremalicious](https://github.com/kremalicious))