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
No description
11 commits 1 branch 0 tags 161 KiB
TypeScript 97.4%
SCSS 2.6%
Find a file
saberzero1 f0fe3d6ca2
fix: remove template boilerplate test files and add passWithNoTests
2026-03-09 03:21:37 +01:00
.github/workflows Initial commit 2026-02-13 16:54:33 +01:00
src deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:04:02 +01:00
.eslintrc.json Initial commit 2026-02-13 16:54:33 +01:00
.gitignore Initial commit 2026-02-13 16:54:33 +01:00
.prettierrc Initial commit 2026-02-13 16:54:33 +01:00
CHANGELOG.md Initial commit 2026-02-13 16:54:33 +01:00
LICENSE Initial commit 2026-02-13 16:54:33 +01:00
package-lock.json deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:04:02 +01:00
package.json fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json Initial commit 2026-02-13 16:54:33 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01:00
vitest.config.ts fix: remove template boilerplate test files and add passWithNoTests 2026-03-09 03:21:37 +01:00

README.md

@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