mirror of https://github.com/quartz-community/content-meta.git synced 2026-07-22 02:50:23 +00:00

No description

Find a file

saberzero1 f01c46b8b3 docs: update README for v5 unified config system		2026-02-25 16:07:11 +01:00
.github/workflows	Initial commit	2026-02-13 16:53:51 +01:00
src	feat: migrate ContentMeta component from Quartz v5 core	2026-02-13 17:14:37 +01:00
.eslintrc.json	Initial commit	2026-02-13 16:53:51 +01:00
.gitignore	Initial commit	2026-02-13 16:53:51 +01:00
.prettierrc	Initial commit	2026-02-13 16:53:51 +01:00
CHANGELOG.md	Initial commit	2026-02-13 16:53:51 +01:00
LICENSE	Initial commit	2026-02-13 16:53:51 +01:00
package-lock.json	chore: update @quartz-community/types to v0.2.1	2026-02-13 22:58:24 +01:00
package.json	fix: move tsup and typescript to dependencies for git install compatibility	2026-02-23 01:09:43 +01:00
README.md	docs: update README for v5 unified config system	2026-02-25 16:07:11 +01:00
tsconfig.json	Initial commit	2026-02-13 16:53:51 +01:00
tsup.config.ts	feat: migrate ContentMeta component from Quartz v5 core	2026-02-13 17:14:37 +01:00
vitest.config.ts	Initial commit	2026-02-13 16:53:51 +01:00

@quartz-community/content-meta

Displays content metadata such as creation date and reading time.

Installation

npx quartz plugin add github:quartz-community/content-meta

plugins:
  - source: github: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,
});

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.

See the Quartz documentation for more information.

MIT