A Neovim plugin for checking, unchecking and toggling Markdown checkboxes.
Find a file
2023-02-06 10:36:42 +00:00
docs/technical-design docs: add initial thoughts 2022-08-13 17:46:18 +01:00
lua feat: add a ToggleCheckbox user command 2023-02-06 10:36:42 +00:00
LICENCE Create LICENCE 2022-08-13 18:24:31 +01:00
README.md docs: update README 2022-08-09 09:24:10 -04:00

toggle-checkbox.nvim

A Neovim plugin for checking and unchecking Markdown checkboxes, written in Lua.

Inspired by jkramer/vim-checkbox.

Example

This is an example of the TODOs that I was using and testing with whilst writing this plugin:

- [ ] Check an unchecked checkbox
- [x] Uncheck a checked checkbox
- [ ] Make check symbol customisable
- [x] Make checking toggleable
  - [x] Determine if a line contains a checked checkbox
- [x] Add README
- [x] Add example keymaps

Keymaps

There are no default keymaps but these can be added using vim.keymap.set():

vim.keymap.set("n", "<leader>tt", ":lua require('toggle-checkbox').toggle()<CR>")