tag-page/README.md

1.3 KiB

@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 github:quartz-community/tag-page

Usage

plugins:
  - source: github:quartz-community/tag-page
    enabled: true

For advanced use cases, you can override in TypeScript:

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

ExternalPlugin.TagPage({
  numPages: 10,
  prefixTags: false,
});

Configuration

Option Type Default Description
sort SortFn undefined A function to sort the pages with the tag.
numPages number undefined The number of pages to show per tag page.
prefixTags boolean false Whether to prefix generated tag page titles with "Tag: " (e.g. "Tag: recipes").

Documentation

See the Quartz documentation for more information.

License

MIT