-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Brendon Lasley edited this page Sep 12, 2026
·
2 revisions
A desktop widget for DankMaterialShell that shows RSS and Atom feeds, fetched directly or synced from Miniflux or any Google Reader API server.
The README covers installation, features and the keyboard reference. These pages are the detail behind it.
| Page | What it covers |
|---|---|
| Architecture | How the plugin is structured, the backend interface, and two rules that break things quietly if ignored |
| Sources and Sync | Standard RSS, Miniflux and Google Reader — setup, credentials, and what each server does differently |
| Notes Export | Exporting articles as markdown, full-text extraction, and opening notes in your editor |
| Data and Persistence | Where settings and state live, and how to reset them |
| Development | Running the tests, the QML harness, the live server suites, and the extraction oracle |
| CI | What runs on a pull request, and why the QML check is qmlformat rather than qmllint
|
| Roadmap | What is built, what is planned, and what was deliberately dropped |
| Related Plugins | Other DMS plugins worth knowing about |
They are written in docs/wiki/ in the main repository and pushed here as a
publish step. The wiki is a separate repo with no pull requests and no CI, so
pages edited directly here drift from the code with nothing to catch it.
Editing them in the main repo means a behaviour change and its documentation
land in one reviewable commit.
If you fix something here, please also fix it in docs/wiki/ — otherwise the
next publish will overwrite it.