quartz/docs/plugins/Darkmode.md
2026-02-25 21:00:33 +01:00

33 lines
748 B
Markdown

---
title: Darkmode
tags:
- plugin/component
---
Dark mode toggle.
> [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
See [[darkmode]] for detailed usage information.
## Configuration
This plugin accepts the following configuration options:
- `enabled`: Whether to enable the dark mode toggle. Defaults to `true`.
### Default options
```yaml title="quartz.config.yaml"
- source: github:quartz-community/darkmode
enabled: true
```
## API
- Category: Component
- Function name: `ExternalPlugin.Darkmode()`.
- Source: [`quartz-community/darkmode`](https://github.com/quartz-community/darkmode)
- Install: `npx quartz plugin add github:quartz-community/darkmode`