Files
quartz/docs/plugins/FolderPage.md
saberzero1 05b79e1d60 docs: add missing options to component and page type plugin documentation
- Graph: add focusOnHover and numeric defaults for all D3Config options
- Search: add enablePreview and fieldPriority options
- TableOfContents: add layout component option
- FolderPage: add showFolderCount and showSubfolders options
- TagPage: add numPages option
- BasesPage: add linkResolution option
2026-05-22 20:07:48 +02:00

1.3 KiB

title, tags, image
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:

  • showFolderCount: Whether to display the number of pages in the folder. Defaults to true.
  • showSubfolders: Whether to include pages from subfolders in the listing. Defaults to true.
  • 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.
  • 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