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
17 commits 1 branch 0 tags 233 KiB
TypeScript 98.6%
SCSS 1.4%
Find a file
saberzero1 730f91b271
chore: commit dist/ and remove prepare script 
Pre-built output is now committed to the repository so that
Quartz can skip the build step during plugin installation.
The prepare script is removed to prevent redundant builds
when installing from npm/git.
2026-03-14 22:00:53 +01:00
.github/workflows Initial commit 2026-02-13 12:18:48 +01:00
dist chore: commit dist/ and remove prepare script 2026-03-14 22:00:53 +01:00
src feat(plugins): recent-notes as community plugin 2026-02-13 13:19:00 +01:00
test feat(plugins): recent-notes as community plugin 2026-02-13 13:19:00 +01:00
.eslintrc.json Initial commit 2026-02-13 12:18:48 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:00:53 +01:00
.prettierrc Initial commit 2026-02-13 12:18:48 +01:00
CHANGELOG.md Initial commit 2026-02-13 12:18:48 +01:00
LICENSE Initial commit 2026-02-13 12:18:48 +01:00
package-lock.json chore: commit dist/ and remove prepare script 2026-03-14 22:00:53 +01:00
package.json chore: commit dist/ and remove prepare script 2026-03-14 22:00:53 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json feat(plugins): recent-notes as community plugin 2026-02-13 13:19:00 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01: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.
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