mirror of
https://github.com/alrayyes/wiki.git
synced 2024-11-22 11:36:23 +00:00
24 lines
1.1 KiB
Markdown
24 lines
1.1 KiB
Markdown
---
|
|
title: FolderPage
|
|
tags:
|
|
- plugin/emitter
|
|
---
|
|
|
|
This plugin generates index pages for folders, creating a listing page for each folder that contains multiple content files. See [[folder and tag listings]] for more information.
|
|
|
|
Example: [[advanced/|Advanced]]
|
|
|
|
> [!note]
|
|
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
|
|
|
The pages are displayed using the `defaultListPageLayout` in `quartz.layouts.ts`. For the content, the `FolderContent` component is used. If you want to modify the layout, you must edit it directly (`quartz/components/pages/FolderContent.tsx`).
|
|
|
|
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.
|
|
|
|
## API
|
|
|
|
- Category: Emitter
|
|
- Function name: `Plugin.FolderPage()`.
|
|
- Source: [`quartz/plugins/emitters/folderPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/folderPage.tsx).
|