https://github.com/massix/org-checkbox.nvim

Very simple plugin to convert lists into checkboxes in org-mode files
https://github.com/massix/org-checkbox.nvim

neovim neovim-plugin nvim nvim-orgmode nvim-plugin orgmode-nvim

Last synced: 13 days ago
JSON representation

Very simple plugin to convert lists into checkboxes in org-mode files

• Host: GitHub
• URL: https://github.com/massix/org-checkbox.nvim
• Owner: massix
• License: other
• Created: 2024-02-23T13:58:03.000Z (9 months ago)
• Default Branch: trunk
• Last Pushed: 2024-02-25T14:19:41.000Z (9 months ago)
• Last Synced: 2024-04-15T23:13:52.699Z (7 months ago)
• Topics: neovim, neovim-plugin, nvim, nvim-orgmode, nvim-plugin, orgmode-nvim
• Language: Lua
• Homepage:
• Size: 1.95 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Org Checkbox

Small plugin to convert list into checkboxes and viceversa.

## Installation

To install the plugin, simply add the following lines with your favourite

plugin manager, the example below is using [Lazy](https://github.com/folke/lazy.nvim):

```lua

{

  "massix/org-checkbox.nvim",

  config = function()

    require("orgcheckbox").setup()

  end,

  ft = { "org" },

}

```

## Usage

The plugin automatically registers a buffer-local mapping set by default to

`oC` which, if triggered on a list item it will toggle it between a

checkbox and a standard list item.

If you want to change the default mapping, call `setup` with an `lhs` option:

```lua

{

  "massix/org-checkbox.nvim",

  config = function()

    require("orgcheckbox").setup({ lhs = "oT" })

  end,

}

```