Quartz's default footer plugin.
  • TypeScript 97.9%
  • SCSS 2.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:03:04 +01:00
.changeset chore: version package 2026-11-09 04:06:15 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src feat: message option for extra footer text (HTML allowed) (#2444) 2026-11-08 00:13:24 +01:00
test feat: message option for extra footer text (HTML allowed) (#2444) 2026-11-08 00:13:24 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:13 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 16:54:33 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:06:15 +00:00
LICENSE Initial commit 2026-02-13 16:54:33 +01:00
package-lock.json chore: version package 2026-11-09 04:06:15 +00:00
package.json chore: version package 2026-11-09 04:06:15 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:48 +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 16:54:33 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:23 +01:00
vitest.config.ts fix: remove template boilerplate test files and add passWithNoTests 2026-03-09 03:21:37 +01:00

@quartz-community/footer

Renders a footer with a "Created with Quartz" message and configurable links.

Installation

npx quartz plugin add @quartz-community/footer

Usage

This plugin is already enabled in the default quartz.config.yaml:

plugins:
  - source: "@quartz-community/footer"
    enabled: true
    options:
      links:
        GitHub: https://github.com/jackyzha0/quartz
        Discord Community: https://discord.gg/cRFFHYye7t
      message: 'Licensed under <a href="/license">CC BY 4.0</a>'

Configuration

Option Type Default Description
links Record<string, string> Quartz GitHub and Discord links A map of link labels to their URLs to display in the footer. Set links: {} for none.
message string not set Extra text shown below the "Created with Quartz" line, e.g. a license notice. HTML is allowed.

Layout

The footer component uses position: footer by default. You can override this in your quartz.config.yaml:

plugins:
  - source: "@quartz-community/footer"
    enabled: true
    layout:
      position: footer
      priority: 50

To disable the footer, set enabled: false.

Documentation

See the Quartz documentation for more information.

License

MIT