mirror of https://github.com/quartz-community/og-image.git synced 2026-07-22 02:50:23 +00:00

No description

Find a file

saberzero1 e711d4ea63 chore: commit dist/ and remove prepare script Pre-built output is now committed to the repository so that Quartz can skip the build step during plugin installation. The prepare script is removed to prevent redundant builds when installing from npm/git.		2026-03-14 22:00:34 +01:00
.github/workflows	Initial commit	2026-02-13 23:35:47 +01:00
dist	chore: commit dist/ and remove prepare script	2026-03-14 22:00:34 +01:00
src	fix: resolve ESLint and formatting issues for CI compliance	2026-03-09 03:47:13 +01:00
.eslintrc.json	Initial commit	2026-02-13 23:35:47 +01:00
.gitignore	chore: commit dist/ and remove prepare script	2026-03-14 22:00:34 +01:00
.prettierrc	Initial commit	2026-02-13 23:35:47 +01:00
CHANGELOG.md	Initial commit	2026-02-13 23:35:47 +01:00
LICENSE	Initial commit	2026-02-13 23:35:47 +01:00
package-lock.json	chore: commit dist/ and remove prepare script	2026-03-14 22:00:34 +01:00
package.json	chore: commit dist/ and remove prepare script	2026-03-14 22:00:34 +01:00
README.md	docs: update README for v5 unified config system	2026-02-25 16:07:11 +01:00
tsconfig.json	Implement og-image emitter plugin	2026-02-13 23:53:16 +01:00
tsup.config.ts	fix: resolve ESLint and formatting issues for CI compliance	2026-03-09 03:47:13 +01:00
vitest.config.ts	fix: add passWithNoTests to vitest config	2026-03-09 03:21:30 +01:00

@quartz-community/og-image

Generates Open Graph social preview images for each page using Satori and Sharp.

Installation

npx quartz plugin add github:quartz-community/og-image

plugins:
  - source: github:quartz-community/og-image
    enabled: true

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.CustomOgImages({
  colorScheme: "lightMode",
  width: 1200,
  height: 630,
});

Option	Type	Default	Description
`colorScheme`	`"lightMode" \| "darkMode"`	`"lightMode"`	The color scheme to use for the generated images.
`width`	`number`	`1200`	The width of the generated images.
`height`	`number`	`630`	The height of the generated images.
`excludeRoot`	`boolean`	`false`	Whether to exclude the root page from image generation.
`defaultTitle`	`string`	`"Untitled"`	The default title to use if a page has no title.
`defaultDescription`	`string`	`"No description provided"`	The default description to use if a page has no description.
`readingTimeText`	`(minutes: number) => string`	`undefined`	A function to format the reading time text.
`imageStructure`	`function`	`undefined`	A function to define the structure of the generated image.

See the Quartz documentation for more information.

MIT