mirror of
https://github.com/ZetaKebab/quartz.git
synced 2024-09-16 08:10:09 +00:00
81a4e20236
* feat: ability to hide tags in the recent notes component * docs: recent notes custom parameters in a table * docs: revert recent notes doc to bullet points * fix: linter issues * Update docs/features/recent notes.md --------- Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
18 lines
1.5 KiB
Markdown
18 lines
1.5 KiB
Markdown
---
|
|
title: Recent Notes
|
|
tags: 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 using `Component.RecentNotes` in `quartz.layout.ts`.
|
|
|
|
## Customization
|
|
|
|
- Changing the title from "Recent notes": pass in an additional parameter to `Component.RecentNotes({ title: "Recent writing" })`
|
|
- Changing the number of recent notes: pass in an additional parameter to `Component.RecentNotes({ limit: 5 })`
|
|
- Display the note's tags (defaults to true): `Component.RecentNotes({ showTags: false })`
|
|
- Show a 'see more' link: pass in an additional parameter to `Component.RecentNotes({ linkToMore: "tags/components" })`. This field should be a full slug to a page that exists.
|
|
- Customize filtering: pass in an additional parameter to `Component.RecentNotes({ filter: someFilterFunction })`. The filter function should be a function that has the signature `(f: QuartzPluginData) => boolean`.
|
|
- Customize sorting: pass in an additional parameter to `Component.RecentNotes({ sort: someSortFunction })`. By default, Quartz will sort by date and then tie break lexographically. The sort function should be a function that has the signature `(f1: QuartzPluginData, f2: QuartzPluginData) => number`. See `byDateAndAlphabetical` in `quartz/components/PageList.tsx` for an example.
|
|
- Component: `quartz/components/RecentNotes.tsx`
|
|
- Style: `quartz/components/styles/recentNotes.scss`
|