quartz-community/footer
1
0
Fork 0
mirror of https://github.com/quartz-community/footer.git synced 2026-07-22 02:50:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
footer/README.md

1.2 KiB
Raw Permalink Blame History

@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.

Documentation

See the Quartz documentation for more information.

License

MIT