mirror of
https://github.com/quartz-community/content-meta.git
synced 2026-11-16 23:53:35 +00:00
Quartz's default content meta plugin.
- TypeScript 98.3%
- SCSS 1.7%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@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