mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-21 21:45:42 -05:00
1.5 KiB
1.5 KiB
| title | tags |
|---|---|
| Recent Notes | component |
Quartz can generate a list of recent notes based on some filtering and sorting criteria. Though this component isn't included in any layout by default, you can add it by installing the plugin and configuring it in quartz.config.yaml.
Note
For information on how to add, remove or configure plugins, see the configuration#Plugins page.
Customization
Most options are configured in the options section of the plugin entry in quartz.config.yaml:
- Changing the title from "Recent notes": set
title: "Recent writing"in options - Changing the number of recent notes: set
limit: 5in options - Display the note's tags (defaults to true): set
showTags: falsein options - Show a 'see more' link: set
linkToMore: "tags/components"in options. This field should be a full slug to a page that exists. - Customize filtering: requires a TS override — pass
filter: someFilterFunctionto the plugin constructor inquartz.ts. The filter function should have the signature(f: QuartzPluginData) => boolean. - Customize sorting: requires a TS override — pass
sort: someSortFunctionto the plugin constructor inquartz.ts. By default, Quartz will sort by date and then tie break lexographically. The sort function should have the signature(f1: QuartzPluginData, f2: QuartzPluginData) => number. - Install:
npx quartz plugin add github:quartz-community/recent-notes - Source:
quartz-community/recent-notes