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
14 commits 1 branch 0 tags 152 KiB
TypeScript 100%
Find a file
saberzero1 1fad982636
fix: add build-time deps for DTS generation 
Peer dependencies needed at build time for TypeScript declaration file
generation were missing from devDependencies. Without them, the DTS build
fails silently, producing no index.d.ts.
2026-03-14 22:26:14 +01:00
.github/workflows Initial commit 2026-02-13 21:39:39 +01:00
dist fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
src fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:47:36 +01:00
.eslintrc.json Initial commit 2026-02-13 21:39:39 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 21:58:14 +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 fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
package.json fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +01:00
tsconfig.json Initial commit 2026-02-13 21:39:39 +01:00
tsup.config.ts feat: extract description transformer from Quartz core 2026-02-13 22:31:19 +01: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