README file from
GithubShopping List — Obsidian Plugin
An Obsidian plugin that renders all checkboxes from the current note as an interactive shopping list. Tick items off, untick them, and clear completed items with a single button click — all reflected live in the underlying markdown.
Usage
Add a shopping-list code block anywhere in a note:
- [ ] Milk
- [ ] Eggs
- [x] Butter
- [ ] Salted kind
- [ ] Coffee
```shopping-list
```
The code block renders an interactive list of all checkboxes in the note. Checking or unchecking an item updates the raw markdown immediately. The "Clear completed (N)" button removes all - [x] lines from the file.
Features
- Reads all
- [ ]and- [x]checkboxes from the active note - Supports
- [ ],* [ ], and indented items - Live toggle: clicking a checkbox flips it in the markdown file
- "Clear completed" button removes all checked items
- Respects your Obsidian theme (light/dark) via CSS variables
- Works on desktop and mobile (
"isDesktopOnly": false)
Installation
From the community plugin store (after publishing)
- Open Obsidian → Settings → Community plugins
- Search for "Shopping List"
- Click Install, then Enable
Manual / development install
See PUBLISHING.md for details on local testing and publishing.
Development
npm install
npm run dev # watch mode — rebuilds main.js on every save
npm run build # type-check + production build
License
MIT