Description

purpose:

• Generates page descriptions for:
  • HTML head metadata
  • RSS Feed
  • folder and tag listings
• Listing placement: between title and listing when main body content is missing.

source:

• Frontmatter description, when present; see authoring content > Syntax.
• Else: first content sentences.

Note

Plugin add/remove/configure: Configuration.

Options

descriptionLength: type: number default: 150 behavior: - Target description length, in characters. - Truncates after first sentence ending after target length.

maxDescriptionLength: type: number default: 300 behavior: - Hard maximum length. - Truncates with ... when exceeded.

replaceExternalLinks: type: boolean default: true behavior: - Replaces external links with domain and path. - Example: https://domain.tld/page?q=1 → domain.tld/page.

API

category: Transformer function: ExternalPlugin.Description() source: quartz-community/description install: npx quartz plugin add github:quartz-community/description