https://github.com/opdavies/toggle-checkbox.nvim

A Neovim plugin for checking, unchecking and toggling Markdown checkboxes.
https://github.com/opdavies/toggle-checkbox.nvim

neovim neovim-lua-plugin neovim-plugin

Last synced: 22 days ago
JSON representation

A Neovim plugin for checking, unchecking and toggling Markdown checkboxes.

• Host: GitHub
• URL: https://github.com/opdavies/toggle-checkbox.nvim
• Owner: opdavies
• License: mit
• Created: 2022-08-09T13:18:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-23T17:46:53.000Z (11 months ago)
• Last Synced: 2024-10-11T12:13:41.369Z (about 1 month ago)
• Topics: neovim, neovim-lua-plugin, neovim-plugin
• Language: Lua
• Homepage:
• Size: 8.79 KB
• Stars: 23
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# toggle-checkbox.nvim

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

Inspired by [jkramer/vim-checkbox](https://github.com/jkramer/vim-checkbox).

## Example

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

```markdown

- [ ] 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()`:

```lua

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

```