quartz-community/description
1
0
Fork 0
mirror of https://github.com/quartz-community/description.git synced 2026-07-22 02:50:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
37 commits 1 branch 0 tags 152 KiB
TypeScript 100%
Find a file
saberzero1 026e63bd46
chore: regenerate package-lock.json
2026-05-24 17:32:48 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:45 +02:00
dist build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:45 +02: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: commit dist/ and remove prepare script 2026-03-14 21:58:14 +01: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 Initial commit 2026-02-13 21:39:39 +01:00
LICENSE Initial commit 2026-02-13 21:39:39 +01:00
package-lock.json chore: regenerate package-lock.json 2026-05-24 17:32:48 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:23:55 +02:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +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

README.md

@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