Joplin Shopping List

A Joplin plugin that turns a Markdown note into an interactive, store-grouped shopping list for groceries.

Use Joplin's editor-toggle button (the "eye" icon, top-right) to switch a note into the shopping view: an input box on top and, below it, your items grouped by store. Type an item and press Enter and it is routed to the right store and sorted into your in-store walking order. You configure each store with simple product terms (e.g. Kartoffeln?); leading/trailing quantities and units (8, 2,5kg, 2 Dosen, …) are matched automatically. Tick items off (they disappear from the view but stay in the Markdown) or push an item to the next matching store. The trash button in the top bar deletes all ticked-off ("bought") items at once, after a confirmation (works on desktop and mobile).

Installation

Download the latest io.github.lansidev.shopping-list.jpl from the Releases page. Requires Joplin 3.5 or newer (desktop or Android).

Desktop (Windows / macOS / Linux)

1. Open Tools → Options → Plugins.
2. Click the gear icon (Plugin tools) next to the search box, then Install from file.
3. Select the downloaded .jpl.
4. Fully quit and restart Joplin — close it completely; minimising to the tray is not enough.

Mobile — Android

1. Download the .jpl onto your phone (e.g. open the Releases page in your mobile browser).
2. In Joplin open Configuration (⚙) → Plugins.
3. Open Advanced settings, then tap Install from file.
4. Pick the downloaded .jpl.
5. Restart the app.

Mobile — iOS / iPadOS

Not supported: to comply with App Store rules the iOS app can only install recommended plugins from Joplin's catalogue, so a .jpl from this repo cannot be side-loaded there.

Updating

Install the newer .jpl the same way — it replaces the existing version. Restart Joplin afterwards.

Build from source

nix develop        # or: nix-shell   (provides Node 20 + npm)
npm install
npm test           # run unit tests
npm run dist       # build publish/io.github.lansidev.shopping-list.jpl

Then install the resulting publish/io.github.lansidev.shopping-list.jpl as described under Installation, or point Joplin's development plugins folder at this repo's publish/ (or dist/) directory.

Usage

1. In a note, run Tools → Shopping List: Enable for this note (adds a hidden <!-- shopping-list --> marker). Add ## Store sections with - [ ] items.
2. Configure stores (one product term per line) and the recognised units via Tools → Shopping List: Edit configuration (two fields in one dialog).
3. Use Joplin's editor-toggle button (top-right) to switch between the Markdown editor and the shopping view. It appears automatically for notes that contain the marker.

Documentation

See /docs (OKF / Knowledge-Catalog format): specification · architecture · design patterns. Contributor guidance is in AGENTS.md.

License

MIT — see LICENSE.