- TypeScript 70.4%
- JavaScript 25.7%
- SCSS 3%
- CSS 0.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github | ||
| content | ||
| quartz | ||
| scripts | ||
| .gitattributes | ||
| .gitignore | ||
| .node-version | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| blacklist.json | ||
| CODE_OF_CONDUCT.md | ||
| globals.d.ts | ||
| index.d.ts | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| plugins.json | ||
| plugins.schema.json | ||
| quartz.config.default.yaml | ||
| quartz.config.yaml | ||
| quartz.ts | ||
| README.md | ||
| tsconfig.json | ||
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
- Give your plugin a
quartzfield in itspackage.json, at leastnameandcategory. See the plugin manifest reference and the plugin template. DeclarequartzVersionwhen the plugin needs a newer Quartz, anddeprecatedwhen it is no longer maintained. - Add the
quartz-plugintopic to the GitHub repository. - 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:
- Runs
scripts/index-plugins.ts. It searches GitHub for thequartz-plugintopic, reads each repository'spackage.jsonandREADME.md, checks npm, and writesplugins.jsonandcontent/plugins/<owner>/<repo>.md. Eachplugins.jsonentry is checked againstplugins.schema.json; an entry that doesn't fit is left out and reported. - 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, andcapabilities(what it provides and needs). - Status: deprecated, and
builtinfor the official plugins built into Quartz 5.1 (crawl-links, remove-draft, content-index), with theconfigurationkey that replaces them. - Configuration: default order, enabled state, options,
configSchemaand the flatoptionSchema. - Where to get it:
source(the npm package when published, elsegithub: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.