Quartz's default alias redirects plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:00:44 +01:00
.changeset chore: version package 2026-11-09 17:20:18 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src fix: resolve relative aliases with path.posix (Windows gave notes\old and a wrong redirect); tests for ./ and ../ aliases 2026-11-09 18:12:57 +01:00
test fix: resolve relative aliases with path.posix (Windows gave notes\old and a wrong redirect); tests for ./ and ../ aliases 2026-11-09 18:12:57 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:40 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 23:34:49 +01:00
CHANGELOG.md chore: version package 2026-11-09 17:20:18 +00:00
LICENSE Initial commit 2026-02-13 23:34:49 +01:00
package-lock.json chore: version package 2026-11-09 17:20:18 +00:00
package.json chore: version package 2026-11-09 17:20:18 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:16 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Implement alias-redirects emitter plugin 2026-02-13 23:53:13 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:14 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/alias-redirects

Generates HTML redirect pages for frontmatter aliases and case-preserving URLs, so old URLs redirect to the canonical page.

  • Aliases: aliases / alias frontmatter entries become redirect pages. A relative alias (./old, ../x) is resolved against the page's folder. An alias that is another page's address (or the page's own) is skipped with a warning, so a redirect never replaces a page.
  • Permalinks: a note with a permalink is published at its permalink, and its file path becomes a redirect to it.
  • Case redirects: URLs whose casing changed due to v5's lowercase slug normalization (e.g. /Diary/My-Note → /diary/my-note) get a redirect page. This is skipped automatically on case-insensitive filesystems.

Installation

npx quartz plugin add @quartz-community/alias-redirects

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/alias-redirects"
    enabled: true

Configuration

Option Type Default Description
enableCaseRedirects boolean true Automatically generate redirect pages for URLs that changed casing due to v5's lowercase normalization.

Documentation

See the Quartz documentation for more information.

License

MIT