mirror of
https://github.com/quartz-community/recent-notes.git
synced 2026-07-22 02:50:28 +00:00
No description
2e9753c996
Respect the file.data.unlisted convention. Pages marked unlisted are filtered out of the recent notes list before any user-supplied opts.filter runs, so they cannot be accidentally surfaced by a permissive custom filter. Extracts the filter into a named filterListedPages() helper and exports it for reuse and testing. Adds 3 unit tests covering unlisted exclusion, passthrough when nothing is unlisted, and empty-input handling. |
||
|---|---|---|
| .github/workflows | ||
| dist | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@quartz-community/recent-notes
Displays a list of recently modified or created notes.
Installation
npx quartz plugin add github:quartz-community/recent-notes
Usage
plugins:
- source: github:quartz-community/recent-notes
enabled: true
For advanced use cases, you can override in TypeScript:
import * as ExternalPlugin from "./.quartz/plugins";
ExternalPlugin.RecentNotes({
title: "Recent Notes",
limit: 3,
showTags: true,
linkToMore: false,
});
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
title |
string |
undefined |
The title of the recent notes section. |
limit |
number |
3 |
The maximum number of notes to display. |
linkToMore |
string | false |
false |
A link to a page with more notes, or false to disable. |
showTags |
boolean |
true |
Whether to display tags for each note. |
filter |
function |
() => true |
A function to filter the notes. |
sort |
function |
byDateAndAlphabetical |
A function to sort the notes. |
Documentation
See the Quartz documentation for more information.
License
MIT