mirror of
https://github.com/quartz-community/footer.git
synced 2026-11-16 23:53:40 +00:00
Quartz's default footer plugin.
- TypeScript 97.9%
- SCSS 2.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@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