Quartz's default description plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:02:15 +01:00
.changeset chore: version package 2026-11-09 02:15:02 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:25 +01:00
src refactor: remove duplicate vfile DataMap fields now in @quartz-community/types 2026-04-03 15:45:24 +02:00
types fix: centralize type declarations and fix formatting 2026-03-16 18:54:54 +01:00
.eslintrc.json fix: centralize type declarations and fix formatting 2026-03-16 18:54:54 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:01 +02:00
.prettierignore fix: centralize type declarations and fix formatting 2026-03-16 18:54:54 +01:00
.prettierrc Initial commit 2026-02-13 21:39:39 +01:00
CHANGELOG.md chore: version package 2026-11-09 02:15:02 +00:00
LICENSE Initial commit 2026-02-13 21:39:39 +01:00
package-lock.json chore: version package 2026-11-09 02:15:02 +00:00
package.json chore: version package 2026-11-09 02:15:02 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:18 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 21:39:39 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:45 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/description

Generates page descriptions for use in meta tags, the RSS feed and folder/tag listings.

A frontmatter description is used as-is. Otherwise the description is built from the first sentences of the content: whole sentences are added while the description stays within descriptionLength (the sentence that would exceed it is left out, but the first sentence is always kept), and the result is truncated with an ellipsis at maxDescriptionLength.

Installation

npx quartz plugin add @quartz-community/description

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/description"
    enabled: true
    options:
      descriptionLength: 150
      maxDescriptionLength: 300
      replaceExternalLinks: true
    order: 70

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 Target length; whole sentences are added up to this length.
maxDescriptionLength number 300 Hard maximum; longer generated descriptions are truncated with ....
replaceExternalLinks boolean true Replace external links (in generated and frontmatter descriptions) with their domain and path.

Documentation

See the Quartz documentation for more information.

License

MIT