@quartz-community/description
v0.1.0
Published
Description transformer plugin for Quartz
Readme
@quartz-community/description
Generates page descriptions from content for use in meta tags and RSS feeds.
Installation
npx quartz plugin add github:quartz-community/descriptionUsage
plugins:
- source: github:quartz-community/description
enabled: trueFor 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
