mirror of https://github.com/quartz-community/recent-notes.git synced 2026-07-22 02:50:28 +00:00

feat: add hideTagPages and hideFolderPages options

Both default to false so existing behavior is preserved. When enabled,
they exclude generated tag index pages (slugs under the 'tags/' prefix)
and folder index pages (slugs matching Quartz's folder-path convention,
delegated to isFolderPath from @quartz-community/utils) from the recent
notes list. The new filters run before any user-supplied opts.filter,
mirroring the existing unlisted filter.

Exports isTagPageSlug and isFolderPageSlug helpers so they can be
composed into custom filter functions, with unit tests for both.

2026-04-16 19:13:16 +02:00

2.2 KiB

Raw Blame History

@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.
`hideTagPages`	`boolean`	`false`	Hide generated tag pages (slugs under `tags/`) from the list.
`hideFolderPages`	`boolean`	`false`	Hide generated folder index pages (slugs ending in `/` or `/index`) from the list.
`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

2.2 KiB Raw Blame History