Quartz's default tag page plugin.
  • TypeScript 98.6%
  • SCSS 1.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:28:29 +01:00
.changeset chore: version package 2026-11-09 22:27:19 +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: pass the plugin options to the tag listing (body is called with undefined, so numPages and sort were ignored) 2026-11-09 21:41:03 +01:00
test fix: pass the plugin options to the tag listing (body is called with undefined, so numPages and sort were ignored) 2026-11-09 21:41:03 +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:07:48 +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 18:36:35 +01:00
CHANGELOG.md chore: version package 2026-11-09 22:27:19 +00:00
LICENSE Initial commit 2026-02-13 18:36:35 +01:00
package-lock.json chore: version package 2026-11-09 22:27:19 +00:00
package.json chore: version package 2026-11-09 22:27:19 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:51 +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 Initial commit 2026-02-13 18:36:35 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:49 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/tag-page

Renders tag pages showing all content tagged with a specific tag. Automatically generates virtual pages for all tags found across content.

Installation

npx quartz plugin add @quartz-community/tag-page

Tag pages are already in Quartz's default configuration.

Usage

plugins:
  - source: "@quartz-community/tag-page"
    enabled: true
    options:
      numPages: 10
      prefixTags: false

sort takes a function, so it needs a TypeScript override:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.TagPage({
  numPages: 10,
  sort: (f1, f2) => (f1.frontmatter?.title ?? "").localeCompare(f2.frontmatter?.title ?? ""),
});

Configuration

Option Type Default Description
numPages number 10 On the tag index page (/tags), the maximum number of pages listed under each tag; a tag's own page lists all of them.
prefixTags boolean false Whether to prefix generated tag page titles with the localized "Tag" label (e.g. "Tag: recipes").
sort SortFn folders first, then date, title A function (f1, f2) => number to sort the pages with the tag. By default: folders first, then newest first, then by title. Requires a TS override.

numPages and sort take effect since version 1.0.4.

A page with a nested tag such as #project/alpha is listed under both project/alpha and project. Writing a note at tags/<tag>.md adds your own text above the generated listing.

Documentation

See the Quartz documentation for more information.

License

MIT