quartz-community/content-meta
1
0
Fork 0
mirror of https://github.com/quartz-community/content-meta.git synced 2026-07-22 02:50:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
13 commits 1 branch 0 tags 184 KiB
TypeScript 98.3%
SCSS 1.7%
Find a file
saberzero1 b6a89c9954
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 21:57:39 +01:00
.github/workflows Initial commit 2026-02-13 16:53:51 +01:00
dist chore: commit dist/ and remove prepare script 2026-03-14 21:57:39 +01:00
src deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:04:02 +01:00
.eslintrc.json Initial commit 2026-02-13 16:53:51 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 21:57:39 +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: commit dist/ and remove prepare script 2026-03-14 21:57:39 +01:00
package.json chore: commit dist/ and remove prepare script 2026-03-14 21:57:39 +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 fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:50 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@quartz-community/content-meta

Displays content metadata such as creation date and reading time.

Installation

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

Usage

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,
});

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