docs: standardize and validate plugin READMEs

This commit is contained in:
Lemmy
2026-07-15 21:56:42 -04:00
parent 1148c2d698
commit c057379c91
17 changed files with 700 additions and 70 deletions
+28 -3
View File
@@ -1,3 +1,28 @@
# mangowm-keymode
![mangowm keymode thumbnail](thumbnail.webp)
**Mangowm Keymode** is a bar widget plugin written for Noctalia (v5) that displays the current keymode from window manager [MANGOWM](https://mangowm.github.io/). It also notifies you when the keymode changes. Notification and bar text are configurable and can be disabled.
# Mangowm Keymode
Mangowm Keymode adds a bar widget that displays MangoWC's current keymode and
can notify you whenever the active keymode changes.
## Plugin
| Field | Value |
| --- | --- |
| ID | `gambled23/mangowm-keymode` |
| Entry | Bar widget: `mangowm-keymode` |
## Requirements
This plugin requires MangoWC and its `mmsg` command on `PATH`. It listens to
`mmsg watch keymode` for live keymode changes.
## Usage
Add the `mangowm-keymode` widget from Noctalia's widget picker. It updates as
MangoWC changes keymode; click it to show the current keymode in a notification.
## Settings
| Setting | Type | Default | Description |
| --- | --- | --- | --- |
| `show_text` | `bool` | `true` | Shows the current keymode beside the widget glyph. |
| `notify_change` | `bool` | `true` | Sends a notification when the keymode changes. |