pending.nvim/README.md
Barrett Ruth 530009d830 refactor(icons): unify category/header icon and use checkbox overlays
Problem: `header` and `category` were separate icons for the same
concept. The icon overlay replaced `[ ]` with a bare character,
hiding the markdown checkbox syntax. Header format `## ` produced
a double-space with single-char icons.

Solution: merge `header` into `category` (one icon for both header
lines and EOL labels). Overlay renders `[icon]` preserving bracket
syntax. Change header line format from `## ` to `# ` so the
2-char overlay (`# `) maps cleanly.
2026-03-04 18:42:26 -05:00

46 lines
924 B
Markdown

# pending.nvim
Edit tasks like text. `:w` saves them.
![demo](assets/demo.gif)
## Requirements
- Neovim 0.10+
- (Optionally) `curl` and `openssl` for Google Calendar and Google Task sync
## Installation
Install with your package manager of choice or via
[luarocks](https://luarocks.org/modules/barrettruth/pending.nvim):
```
luarocks install pending.nvim
```
## Documentation
```vim
:help pending.nvim
```
## Icons
All display characters are configurable. Defaults produce markdown-style checkboxes (`[ ]`, `[x]`, `[!]`):
```lua
vim.g.pending = {
icons = {
pending = ' ', done = 'x', priority = '!',
due = '.', recur = '~', category = '#',
},
}
```
See `:help pending.Icons` for nerd font examples.
## Acknowledgements
- [dooing](https://github.com/atiladefreitas/dooing)
- [todo-comments.nvim](https://github.com/folke/todo-comments.nvim)
- [todotxt.nvim](https://github.com/arnarg/todotxt.nvim)