1
0
mirror of https://github.com/kremalicious/astro-redirect-from.git synced 2024-12-22 09:23:21 +01:00

readme updates

This commit is contained in:
Matthias Kretschmann 2023-09-23 21:11:07 +01:00
parent 977d39e897
commit 5e7b54d781
Signed by: m
GPG Key ID: 606EEEF3C479A91F

View File

@ -4,9 +4,8 @@
[![npm package](https://img.shields.io/npm/v/astro-redirect-from.svg)](https://www.npmjs.com/package/astro-redirect-from)
[![CI](https://github.com/kremalicious/astro-redirect-from/actions/workflows/ci.yml/badge.svg)](https://github.com/kremalicious/astro-redirect-from/actions/workflows/ci.yml)
<!-- [![Maintainability](https://api.codeclimate.com/v1/badges/9643b2a038a7d338a73a/maintainability)](https://codeclimate.com/github/kremalicious/astro-redirect-from/maintainability)
[![Coverage](https://api.codeclimate.com/v1/badges/9643b2a038a7d338a73a/test_coverage)](https://codeclimate.com/github/kremalicious/astro-redirect-from/test_coverage) -->
[![Maintainability](https://api.codeclimate.com/v1/badges/a20dc7ebee797c2d1e43/maintainability)](https://codeclimate.com/github/kremalicious/astro-redirect-from/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/a20dc7ebee797c2d1e43/test_coverage)](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/).
>
@ -74,6 +73,8 @@ export default defineConfig({
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.
For easy debugging, a `redirect_from.json` is written out into Astro's `cacheDir` setting, which by default is under `node_modules/.astro`.
[See Usage](#usage)
### Options