Quartz's default recent notes plugin.
  • TypeScript 96.7%
  • SCSS 3.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:04:33 +01:00
.changeset chore: version package 2026-11-09 04:09:20 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src fix: let recent notes shrink and scroll in short sidebars (jackyzha0/quartz#2463) 2026-11-07 22:47:27 +01:00
test test: add regression tests for default date type 2026-05-26 22:20:18 +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: migrate to npm publishing 2026-07-23 09:07:32 +02: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 chore: version package 2026-11-09 04:09:20 +00:00
LICENSE Initial commit 2026-02-13 12:18:48 +01:00
package-lock.json chore: version package 2026-11-09 04:09:20 +00:00
package.json chore: version package 2026-11-09 04:09:20 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:50 +01: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 build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:38 +01:00
vitest.config.ts Initial commit 2026-02-13 12:18:48 +01:00

@quartz-community/recent-notes

Displays a list of recently modified or created notes.

Installation

npx quartz plugin add @quartz-community/recent-notes

Quartz's default configuration has a disabled entry for this plugin (without a layout, so the component goes after the page body); set enabled: true to use it.

Usage

plugins:
  - source: "@quartz-community/recent-notes"
    enabled: true
    options:
      limit: 3
      showTags: true
      linkToMore: false
    layout:
      position: afterBody
      priority: 50

filter and sort take functions, so they need a TypeScript override:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.RecentNotes({
  filter: (f) => f.slug?.startsWith("blog/") ?? false,
});

Configuration

Option Type Default Description
title string localized "Recent Notes" The title of the recent notes section.
limit number 3 The maximum number of notes to display.
linkToMore string | false false The slug of a page listing more notes; when set and there are more notes than limit, a "See N more" link is shown.
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 Which pages to include. TS override only.
sort function newest first, then title How to sort the notes, by each page's default date (defaultDateType of created-modified-date). TS override only.

Pages marked unlisted (see @quartz-community/unlisted-pages) are always left out.

Documentation

See the Quartz documentation for more information.

License

MIT