quartz/docs/plugins/TagPage.md

1.3 KiB

title description tags image repository enabled required
TagPage Generates listing pages for tags.
plugin/pageType
[quartz-community/tag-page](https://github.com/quartz-community/tag-page) true false

This plugin is a page type plugin that emits dedicated pages for each tag used in the content. It uses the default layout#Page Frames (three-column layout with sidebars). See folder and tag listings for more information.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins page.

This plugin accepts the following configuration options:

  • numPages: The maximum number of pages to display per tag before showing a "see more" link. Defaults to 10.
  • sort: A function of type (f1: QuartzPluginData, f2: QuartzPluginData) => number{:ts} used to sort entries. Defaults to sorting by date and tie-breaking on lexographical order. Requires a TS override.
  • prefixTags: If true, generated tag page titles are prefixed with "Tag: " (e.g. "Tag: recipes"). Defaults to false.

API

  • Category: Page Type
  • Function name: ExternalPlugin.TagPage().
  • Source: quartz-community/tag-page
  • Install: npx quartz plugin add github:quartz-community/tag-page