@quartz-community/footer

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

Installation

npx quartz plugin add github:quartz-community/footer

Usage

plugins:
  - source: github:quartz-community/footer
    enabled: true
    options:
      links:
        GitHub: https://github.com/jackyzha0/quartz
        Discord Community: https://discord.gg/cRFFHYye7t

For advanced use cases, you can override in TypeScript:

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

ExternalPlugin.Footer({
  links: {
    GitHub: "https://github.com/jackyzha0/quartz",
    "Discord Community": "https://discord.gg/cRFFHYye7t",
  },
});

Configuration

| Option | Type | Default | Description | | ------- | ------------------------ | ------- | ------------------------------------------------------------ | | links | Record<string, string> | {} | A map of link labels to their URLs to display in the footer. |

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