Skip to content

Change your vim or neovim to an ultimate TODO management tool.

License

Notifications You must be signed in to change notification settings

EtiamNullam/vim-todotxt-syntax

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TODOtxt

Simple syntax plugin both for vim and neovim to give a bit of life to your TODO without any bloat.

Features

  • Simple
  • Easy to use
  • A bit of eye-candy with color-coded types of tasks
  • A sense of fulfillment when you complete a task
  • I'm using it daily for 5 years with no issues
  • Fits physical blackboards and paper notes perfectly
  • Addicting

Preview

Whitespaces don't matter and indentation can be useful to create a tree structure:

Whitespaces don't matter

Installation

Use your favorite plugin manager (recommended, both for neovim and vim)
Plug 'EtiamNullam/vim-todotxt-syntax'
Manual (vim)

Move todotxt.vim to ~/vimfiles/syntax (Windows) or ~/.vim/syntax (Unix)

Make sure that syntax is enabled in your vimrc file by syntax enable

Usage

After you've installed the plugin installed every file that ends with .todotxt will have this syntax highlighting enabled.

Start a line with one of these characters to highlight it with various colors:

Character Highlight Group Suggested meaning
- Type To do
+ String Done
! Special Important
? Function Question, optional or needs more information
/ Comment Cancelled

You can use :set filetype=todotxt to force it for current buffer, might be useful for scratch buffers.

Notes