https://github.com/acidghost/obsidian-checklist-progress

Plugin to automatically fill progress (as fraction or percentage) of check-lists
https://github.com/acidghost/obsidian-checklist-progress

obsidian-md obsidian-plugin

Last synced: about 2 months ago
JSON representation

Plugin to automatically fill progress (as fraction or percentage) of check-lists

• Host: GitHub
• URL: https://github.com/acidghost/obsidian-checklist-progress
• Owner: acidghost
• License: gpl-3.0
• Created: 2021-05-18T14:14:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T05:56:37.000Z (6 months ago)
• Last Synced: 2024-06-14T06:50:59.313Z (6 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 63.5 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Checklist Progress

Simple [Obsidian](https://obsidian.md) plugin to automatically update the progress in a list of

tasks. Given, for example, the following note:

```markdown

This is a list (/):

- [x] item one

- [ ] item two (%)

    - [ ] sub item one

    - [x] sub item two

- [x] item three

```

the command provided by this plugin will update it to

```markdown

This is a list (2/3):

- [x] item one

- [ ] item two (50%)

    - [ ] sub item one

    - [x] sub item two

- [x] item three

```

providing the fraction / percentage of completed tasks in a sub-list.

Besides using a command to trigger the update (which you can bind to a keyboard

shortcut), you can also enable auto-updating when toggling a checkbox in

Obsidian Live Preview mode.

Additionally, adding a minus before the fraction or percentage symbol will count

*unchecked* checkboxes. Example:

```markdown

This is a list (-/):

- [x] item one

- [ ] item two

- [x] item three

```

will be updated to

```markdown

This is a list (-1/3):

- [x] item one

- [ ] item two

- [x] item three

```

## Inspiration

This is supposed to mimic a similar feature from [Emacs's Org Mode](https://orgmode.org/manual/Checkboxes.html).