1.5 KiB
| title | tags | |
|---|---|---|
| FolderPage |
|
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/
Note
For information on how to add, remove or configure plugins, see the configuration#Plugins 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. -
globalFolderTitle: If set, the title of a virtual global folder under website root that lists all user-created public posts. This can be used in conjunction with features/recent-notes 's 'See more' link feature for site navigation.As an example, if it's set to "All Posts", a global folder page will be created on
<baseUrl>/all-posts/. An exception is thrown on build if it conflicts with an existing folder.
API
- Category: Emitter
- Function name:
Plugin.FolderPage(). - Source:
quartz/plugins/emitters/folderPage.tsx.