Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1021 Bytes

README.md

File metadata and controls

56 lines (41 loc) · 1021 Bytes

✅ Todo View

todo-view is a lua plugin for Neovim to open the nearest TODO.md in a floating window and can be edited as normal.

image

Note

Not case-insensitive. Will only find TODO.md.

Installation

Install the plugin with your plugin manager.

{
  "Sheeplet1/todo-view.nvim",
  event = "VeryLazy",
  opts = {
    -- your configuration comes here
    -- or leave it empty to use the default settings
    -- refer to the configuration section below
  }
}

Then add to keymaps:

vim.keymap.set("n", "<leader>td", "<cmd>TodoView<CR>", { desc = "Toggle TodoView" })

Configuration

{
    window = {
        height = height,
        width = width,
        border = "rounded",
    },
}

Usage

todo-view finds the closest TODO.md starting from your current working directory.

  • Toggle the TODO window
:TodoView