mirror of
https://github.com/quartz-community/description.git
synced 2026-07-22 02:50:28 +00:00
1.2 KiB
1.2 KiB
@quartz-community/description
Generates page descriptions from content for use in meta tags and RSS feeds.
Installation
npx quartz plugin add github:quartz-community/description
Usage
plugins:
- source: github:quartz-community/description
enabled: true
For advanced use cases, you can override in TypeScript:
import * as ExternalPlugin from "./.quartz/plugins";
ExternalPlugin.Description({
descriptionLength: 150,
});
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
descriptionLength |
number |
150 |
The length of the description to generate. |
maxDescriptionLength |
number |
300 |
The maximum length of the description. |
replaceExternalLinks |
boolean |
true |
Whether to replace external links in the description. |
Documentation
See the Quartz documentation for more information.
License
MIT