Skip to content

ntocampos/todone.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 

Repository files navigation

Todone

Screen.Recording.2025-01-10.at.12.02.31.mp4

Todone is a plugin for managing your daily tasks inside Neovim using a simple and intuitive interface.

Features

  1. Create daily notes and edit them in a floating window.
  2. Toggle tasks as done or undone.
  3. List and search in past notes.
  4. List pending tasks.
  5. Keep track of your current high priority task.
  6. Backup notes however you want (Github, Dropbox, etc).

Installation

This plugin uses pickers to list files and supports either Snacks.nvim picker or Telescope.nvim. They are optional, but highly recommended.

Using Lazy:

use {
  'ntocampos/todone.nvim',
  dependencies = {
    -- Either one or the other
    { "nvim-telescope/telescope.nvim", optional = true },
    { "folke/snacks.nvim", optional = true },
  },
  opts = {
    root_dir = "~/todone/",
    float_position = "topright",
  },
  keys = {
    { "<leader>tt", "<cmd>TodoneToday<cr>",       desc = "Open today's notes" },
    { "<leader>tf", "<cmd>TodoneToggleFloat<cr>", desc = "Toggle priority float" },
    -- The commands below require a picker
    { "<leader>tl", "<cmd>TodoneList<cr>",        desc = "List all notes" },
    { "<leader>tg", "<cmd>TodoneGrep<cr>",        desc = "Search inside all notes" },
    { "<leader>tp", "<cmd>TodonePending<cr>",     desc = "List notes with pending tasks" },
  }
}

Usage

After installing Todone, you can start using the commands or keymaps to interact with it. When you open a note, it will be created if it doesn't exist, and it will be rendered in a floating window. To exit and save the note, press q. Inside the note, you can press enter to toggle a markdown checkbox as done or undone. You can also press N on normal mode to append a new task. The notes are simple markdown files, so you can use all markdown features and also edit them outside Neovim.

Commands

  1. :TodoneToday - Open today's note
  2. :TodoneOpen "yyyy-mm-dd" - Open the note for a specific date, useful for planning ahead
  3. :TodoneToggleFloat - Toggle the priority float
  4. :TodoneList - List all notes
  5. :TodoneGrep - Search inside all notes
  6. :TodonePending - List notes with pending tasks

Backing up notes

Todone notes are simple markdown files, so you can backup them however you want. You can use git, Dropbox, or any other service you prefer.

About

A plugin for managing your daily tasks inside Neovim

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages