FolderPage

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 page frame (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 page.

This plugin accepts the following configuration options:

• showFolderCount: Whether to display the number of entries in the folder (“N items under this folder”). Defaults to true.
• showSubfolders: Whether to list each direct subfolder as an entry of its own (linking to the subfolder’s page). When false, only the pages directly inside the folder are listed. Defaults to true.
• prefixFolders: If true, folder page titles that Quartz generates (and index notes without a title of their own) are prefixed with the localized “Folder” label (e.g. “Folder: notes”). Defaults to false.
• sort: A function of type (f1: QuartzPluginData, f2: QuartzPluginData) => number used to sort entries. Defaults to listing folders first, then pages by date (newest first), tie-breaking on lexicographical title order. Requires a TS override.

Folders are listed even when they hold only pages generated by other page types, such as .base or .canvas pages. Pages hidden with UnlistedPages are left out.

Default options

quartz.config.yaml

- source: "@quartz-community/folder-page"
  enabled: true
  options:
    showFolderCount: true
    showSubfolders: true
    prefixFolders: false

API

• Category: Page Type
• Function name: ExternalPlugin.FolderPage().
• Source: quartz-community/folder-page
• Install: npx quartz plugin add @quartz-community/folder-page (included in the default configuration)