Files
paxad/docs/plugins/Footer.md
2026-07-07 20:48:21 -04:00

40 lines
1.1 KiB
Markdown

---
title: Footer
description: Page footer with configurable links.
tags:
- plugin/component
image:
repository: "[quartz-community/footer](https://github.com/quartz-community/footer)"
enabled: true
required: false
---
This plugin renders a footer at the bottom of the page with a "Created with Quartz" message and a set of configurable links.
> [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
## Configuration
This plugin accepts the following configuration options:
- `links`: A map of link labels to their URLs to display in the footer. Defaults to `{}`.
### Default options
```yaml title="quartz.config.yaml"
- source: github:quartz-community/footer
enabled: true
options:
links:
GitHub: https://github.com/jackyzha0/quartz
Discord Community: https://discord.gg/cRFFHYye7t
```
## API
- Category: Component
- Function name: `ExternalPlugin.Footer()`.
- Source: [`quartz-community/footer`](https://github.com/quartz-community/footer)
- Install: `npx quartz plugin add github:quartz-community/footer`