Quartz's default content meta plugin.
  • TypeScript 98.3%
  • SCSS 1.7%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:01:48 +01:00
.changeset chore: version package 2026-11-09 04:00:33 +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 i18n: add translations for 30 locales from Quartz v4 2026-04-04 01:56:18 +02:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:54 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 16:53:51 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:00:33 +00:00
LICENSE Initial commit 2026-02-13 16:53:51 +01:00
package-lock.json chore: version package 2026-11-09 04:00:33 +00:00
package.json chore: version package 2026-11-09 04:00:33 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:17 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:15:08 +01:00
tsconfig.json Initial commit 2026-02-13 16:53:51 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:13 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/content-meta

Displays content metadata below the article title: the page's date and the estimated reading time.

The date shown is the one selected by the defaultDateType option of created-modified-date (modified by default), so no date is shown when that plugin is disabled. Pages without text content show no metadata.

Installation

npx quartz plugin add @quartz-community/content-meta

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/content-meta"
    enabled: true
    layout:
      position: beforeBody
      priority: 20

For advanced use cases, you can override in TypeScript:

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

ExternalPlugin.ContentMeta({
  showReadingTime: true,
  showComma: true,
});

Configuration

Option Type Default Description
showReadingTime boolean true Whether to display the estimated reading time.
showComma boolean true Whether to display a comma between metadata items.

Documentation

See the Quartz documentation for more information.

License

MIT