https://github.com/arnarg/todotxt.nvim

Neovim plugin to view and add tasks stored in a todo.txt format
https://github.com/arnarg/todotxt.nvim

lua neovim neovim-plugin nvim nvim-plugin todo todotxt

Last synced: 12 days ago
JSON representation

Neovim plugin to view and add tasks stored in a todo.txt format

• Host: GitHub
• URL: https://github.com/arnarg/todotxt.nvim
• Owner: arnarg
• Created: 2022-02-11T23:53:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-05T11:37:58.000Z (over 1 year ago)
• Last Synced: 2024-04-24T02:35:03.220Z (2 months ago)
• Topics: lua, neovim, neovim-plugin, nvim, nvim-plugin, todo, todotxt
• Language: Lua
• Homepage:
• Size: 502 KB
• Stars: 46
• Watchers: 3
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - todotxt.nvim
• awesome-stars - arnarg/todotxt.nvim - Neovim plugin to view and add tasks stored in a todo.txt format (Lua)

README

        
# todotxt.nvim

Neovim plugin to view and add tasks stored in a todo.txt format.

[![asciicast](doc/asciinema.png)](https://asciinema.org/a/DVMyXY3pvUBKNdzu5Ywy9jweE)

## Features

### Sidebar split

Sidebar split to view and manage tasks.

![sidebar](doc/sidebar.png)

### Prompt

Prompt to quickly add new tasks.

![prompt](doc/prompt.png)

## Requirements

- Neovim 0.5.0

- [nui.nvim](https://github.com/MunifTanjim/nui.nvim)

## Installation

With [packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua

use {

	'arnarg/todotxt.nvim',

	requires = {'MunifTanjim/nui.nvim'},

}

```

## Quickstart

Add the `setup()` function to your init file.

For `init.lua`:

```lua

require('todotxt-nvim').setup({

	todo_file = "/path/to/todo.txt",

})

```

For `init.vim`:

```vim

lua <` | Toggles task under cursor as done/not done |

| `m`       | Toggle metadata for task                   |

| `q`       | Close sidebar pane                         |