quartz/docs/plugins/FolderPage.md
2026-03-19 22:18:42 +01:00

1.1 KiB

title tags image
FolderPage
plugin/pageType

This plugin is a page type plugin that generates index pages for folders, creating a listing page for each folder that contains multiple content files. It uses the default layout#Page Frames (three-column layout with sidebars). See folder and tag listings for more information.

Example: advanced/

Note

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

This plugin accepts the following configuration options:

  • 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.
  • prefixFolders: If true, generated folder page titles are prefixed with "Folder: " (e.g. "Folder: notes"). Defaults to false.

API

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