mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-22 05:55:42 -05:00
35 lines
977 B
Markdown
35 lines
977 B
Markdown
---
|
|
title: ContentMeta
|
|
tags:
|
|
- plugin/component
|
|
---
|
|
|
|
This plugin displays content metadata below the article title, such as the creation date and estimated reading time.
|
|
|
|
> [!note]
|
|
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
|
|
|
## Configuration
|
|
|
|
This plugin accepts the following configuration options:
|
|
|
|
- `showReadingTime`: Whether to display the estimated reading time. Defaults to `true`.
|
|
- `showComma`: Whether to display a comma between metadata items. Defaults to `true`.
|
|
|
|
### Default options
|
|
|
|
```yaml title="quartz.config.yaml"
|
|
- source: github:quartz-community/content-meta
|
|
enabled: true
|
|
options:
|
|
showReadingTime: true
|
|
showComma: true
|
|
```
|
|
|
|
## API
|
|
|
|
- Category: Component
|
|
- Function name: `ExternalPlugin.ContentMeta()`.
|
|
- Source: [`quartz-community/content-meta`](https://github.com/quartz-community/content-meta)
|
|
- Install: `npx quartz plugin add github:quartz-community/content-meta`
|