checkbox.nvim

Introduction

This plugin provides an easy way to toggle nested checkboxes of the form:

    [ ] item
        * [ ] item
        - [X] item

Parent and child items are updated automatically when a checkbox is changed. It is easily configurable what may come before the checkbox. Configuring what is skipped when searching for parents and child checkboxes alike is also possible.

Installation

Use your preferred plugin manager and add

"ibutra/checkbox.nvim"

as plugin.

Usage

Add a mapping to the provided function:

vim.keymap.set("n", "<leader>x", require("checkbox").checkbox)

For further details and configuration options see the documentation: Vim Helpfile

License

MIT License

Copyright (c) 2023 Stefan Rakel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.