Skip to content

Repository files navigation

Checklist Summary

Lightweight Obsidian plugin that renders checkbox-status counts next to Markdown sections and list groups in Live Preview and Reading mode.

Features

  • Counts checkbox markers without changing the note.
  • Supports section, local list, nested group, and virtual summaries.
  • Keeps nonstandard task markers separate instead of normalizing them.
  • Ignores ordinary list items when calculating counts.
  • Works on desktop and mobile.

Install with BRAT

  1. Install and enable BRAT.
  2. Run BRAT: Add a beta plugin for testing.
  3. Enter ssfxate/checklist-summary.

BRAT installs the release assets main.js, manifest.json, and styles.css from GitHub Releases.

Development

npm install
npm run check

The editable source is src/main.ts; npm run build produces the distributable main.js.

Release

npm run release:patch

The release command bumps the version, validates and builds the plugin, pushes the commit and tag, and creates a GitHub Release with all BRAT assets.

About

Lightweight checkbox status summaries for Obsidian sections and list groups.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages