quartz-community/recent-notes
1
0
Fork 0
mirror of https://github.com/quartz-community/recent-notes.git synced 2026-07-22 02:50:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
67 commits 1 branch 0 tags 233 KiB
TypeScript 98.6%
SCSS 1.4%
Find a file
saberzero1 92538d7346
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
.github/workflows ci: add dist externals verification step 2026-03-17 19:41:47 +01:00
dist feat: add hideTagPages and hideFolderPages options 2026-04-16 19:13:16 +02:00
src feat: add hideTagPages and hideFolderPages options 2026-04-16 19:13:16 +02:00
test feat: add hideTagPages and hideFolderPages options 2026-04-16 19:13:16 +02:00
types fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.eslintrc.json fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:00:53 +01:00
.prettierignore fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
.prettierrc Initial commit 2026-02-13 12:18:48 +01:00
CHANGELOG.md feat: add hideTagPages and hideFolderPages options 2026-04-16 19:13:16 +02:00
LICENSE Initial commit 2026-02-13 12:18:48 +01:00
package-lock.json deps: update @quartz-community/types and @quartz-community/utils 2026-04-16 13:29:47 +02:00
package.json fix: add components manifest field for RecentNotes component 2026-03-20 13:35:01 +01:00
README.md feat: add hideTagPages and hideFolderPages options 2026-04-16 19:13:16 +02:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json fix: centralize type declarations and add missing peer dependency 2026-03-16 18:54:39 +01:00
tsup.config.ts fix: bundle @quartz-community/utils to avoid runtime subpath resolution failures 2026-04-04 11:36:41 +02:00
vitest.config.ts Initial commit 2026-02-13 12:18:48 +01:00

README.md

@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