quartz/docs/plugins/RecentNotes.md

47 lines
1.4 KiB
Markdown

---
title: RecentNotes
description: Displays a list of recently modified notes.
tags:
- plugin/component
image:
repository: "[quartz-community/recent-notes](https://github.com/quartz-community/recent-notes)"
enabled: false
required: false
---
Shows recently modified notes.
> [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[recent notes]] for detailed usage information.
## Configuration
This plugin accepts the following configuration options:
- `title`: The title of the recent notes section. Defaults to `Recent notes`.
- `limit`: The maximum number of recent notes to display. Defaults to `3`.
- `showTags`: Whether to display the tags for each note. Defaults to `true`.
- `linkToMore`: A slug to a page that shows more notes. Defaults to `false`.
- `hideTagPages`: Whether to hide tag index pages from the list. Defaults to `false`.
- `hideFolderPages`: Whether to hide folder index pages from the list. Defaults to `false`.
### Default options
```yaml title="quartz.config.yaml"
- source: github:quartz-community/recent-notes
enabled: true
options:
limit: 3
showTags: true
hideTagPages: false
hideFolderPages: false
```
## API
- Category: Component
- Function name: `ExternalPlugin.RecentNotes()`.
- Source: [`quartz-community/recent-notes`](https://github.com/quartz-community/recent-notes)
- Install: `npx quartz plugin add github:quartz-community/recent-notes`