todo.nvim

A simple 🥸 to-do list plugin for Neovim built using lua.

Usage

Use the key mappings:

• <leader>i - Inset new item;
• <leader>x - Toggle item status;

Configure

The to-do plugin needs to be initialized using:

require('todo').setup {}

However, you can pass in some config options, the defaults are:

require('todo').setup {
    -- Symbols used
    done_symbol = "[X] ",
    todo_symbol = "[ ] ",
    -- keymaps used in normal mode to operate the plugin
    new_item_key_map = "<leader>i",
    done_key_map = "<leader>x"
}

Installation

Install just as you would a normal plugin, here are some options:

Built-in package manager

mkdir -p ~/.local/share/nvim/site/pack/plugins/start
cd ~/.local/share/nvim/site/pack/plugins/start
git clone https://github.com/mariogarridopt/todo.nvim

Via a plugin manager

Using packer.nvim:

use "mariogarridopt/todo.nvim"
require('todo').setup()