@quartz-community/folder-page

Renders folder index pages showing a listing of all pages within that folder. Automatically generates virtual index pages for folders that don't have one.

Installation

npx quartz plugin add github:quartz-community/folder-page

Usage

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

const config: QuartzConfig = {
  plugins: {
    pageTypes: [ExternalPlugin.FolderPage()],
  },
};

// quartz.layout.ts
export const layout = {
  byPageType: {
    folder: {
      beforeBody: [...],
      left: [...],
      right: [...],
    },
  },
}

Configuration

Option	Type	Default	Description
`showFolderCount`	`boolean`	`undefined`	Whether to show the number of items in the folder.
`showSubfolders`	`boolean`	`undefined`	Whether to show subfolders in the listing.
`sort`	`SortFn`	`undefined`	A function to sort the pages in the folder.

Documentation

See the Quartz documentation for more information.

License

MIT

1.2 KiB Raw Blame History