No description
  • TypeScript 70.4%
  • JavaScript 25.7%
  • SCSS 3%
  • CSS 0.9%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-16 15:17:32 +00:00
.github chore: remove the copy of Quartz's docs, workflows that only run in jackyzha0/quartz and the Dockerfile; marketplace README 2026-11-10 01:32:08 +01:00
content chore: update plugin index [skip ci] 2026-11-14 22:09:26 +00:00
quartz chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
scripts feat(index): plugins.json schemaVersion 2 — capabilities, optionSchema, npmName, issues; output checked against the schema 2026-11-10 01:31:14 +01:00
.gitattributes Initial commit 2026-08-09 15:34:34 +02:00
.gitignore feat: site 2026-08-09 21:00:32 +02:00
.node-version Initial commit 2026-08-09 15:34:34 +02:00
.npmrc Initial commit 2026-08-09 15:34:34 +02:00
.prettierignore chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
.prettierrc Initial commit 2026-08-09 15:34:34 +02:00
blacklist.json feat: site 2026-08-09 21:00:32 +02:00
CODE_OF_CONDUCT.md Initial commit 2026-08-09 15:34:34 +02:00
globals.d.ts chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
index.d.ts Initial commit 2026-08-09 15:34:34 +02:00
LICENSE.txt Initial commit 2026-08-09 15:34:34 +02:00
package-lock.json chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
package.json chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
plugins.json chore: update plugin index [skip ci] 2026-11-16 15:17:32 +00:00
plugins.schema.json feat(index): plugins.json schemaVersion 2 — capabilities, optionSchema, npmName, issues; output checked against the schema 2026-11-10 01:31:14 +01:00
quartz.config.default.yaml chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
quartz.config.yaml chore: update Quartz to 5.1.0 2026-11-10 00:01:14 +01:00
quartz.ts Initial commit 2026-08-09 15:34:34 +02:00
README.md chore: remove the copy of Quartz's docs, workflows that only run in jackyzha0/quartz and the Dockerfile; marketplace README 2026-11-10 01:32:08 +01:00
tsconfig.json Initial commit 2026-08-09 15:34:34 +02:00

Quartz Plugin Marketplace

A searchable index of Quartz plugins, first-party and community: https://quartz-community.github.io/marketplace/

The same index is published as JSON at static/plugins.json (schema). Quartz Syncer's plugin browser reads it.

Listing your plugin

  1. Give your plugin a quartz field in its package.json, at least name and category. See the plugin manifest reference and the plugin template. Declare quartzVersion when the plugin needs a newer Quartz, and deprecated when it is no longer maintained.
  2. Add the quartz-plugin topic to the GitHub repository.
  3. The plugin appears within 6 hours. Its page uses the first heading and paragraph of your README.md.

Forks and archived repositories are skipped. A repository or owner can be left out through blacklist.json.

How it works

Every 6 hours, and on every push to v5, index-and-deploy.yaml:

  1. Runs scripts/index-plugins.ts. It searches GitHub for the quartz-plugin topic, reads each repository's package.json and README.md, checks npm, and writes plugins.json and content/plugins/<owner>/<repo>.md. Each plugins.json entry is checked against plugins.schema.json; an entry that doesn't fit is left out and reported.
  2. Commits the result and builds this site with Quartz, then deploys it to GitHub Pages.

The generated files (plugins.json, content/plugins/) are not edited by hand.

plugins.json

schemaVersion 2. Per plugin:

  • What it is: name, display name, description, version (from package.json), category, keywords, components and frames.
  • Compatibility: the Quartz version it needs (quartzVersion), dependencies, and capabilities (what it provides and needs).
  • Status: deprecated, and builtin for the official plugins built into Quartz 5.1 (crawl-links, remove-draft, content-index), with the configuration key that replaces them.
  • Configuration: default order, enabled state, options, configSchema and the flat optionSchema.
  • Where to get it: source (the npm package when published, else github:owner/repo), npmName, repo, issues, stars, licence, last update, and install commands.

Development

The site is a Quartz site: quartz/, package.json and package-lock.json are Quartz's own, from a release tag. quartz/styles/custom.scss holds the marketplace's styles.

npm ci
GITHUB_TOKEN=<token> npx tsx scripts/index-plugins.ts   # refresh the index
npx quartz build -d content --serve                    # preview the site

To update Quartz, copy quartz/, package.json, package-lock.json and the root config files from the new release tag, keep quartz/styles/custom.scss, and run npx quartz plugin doctor --fix. CI runs npm run check and builds the site.

License

MIT