Giter Club home page Giter Club logo

vim-simple-todo's Introduction

Simple todo in Vim

May be this is the smallest Vim plugin in the world. It adds some useful mappings for manage simple todo lists (example below) and nothing more.

[x] Create plugin
[x] Add help documentation
[x] Publish to GitHub
[ ] Spread the word

Features

  • Support GitHub-like task lists:

    • Works well with different markdown list markers, e.g. -, +, *.
    • So it's easy to create tasks in issues or pull requests on GitHub
  • Each mapping is repeatable via . (require tpope/repeat).

  • Tick symbol is configurable, e.g.

    [y] Water
    [y] Bread
    [ ] Milk
    

Installation

Use your favorite installation method:

  • Tim Pope's pathogen:

    cd .vim/bundle
    git clone https://github.com/vitalk/vim-simple-todo
  • Junegunn Choi's Plug (recommend):

    Plug 'vitalk/vim-simple-todo'
    vim +PlugInstall +qall

Usage

All this mappings use the <leader> key and they work the same on NORMAL and INSERT modes. I prefer to use the comma as the <leader> key but fell free to set your own.

Key Help
,i Create a new todo under cursor
,I Create a new todo for current line
,o Create a new todo below current line
,O Create a new todo above current line
,x Mark todo under cursor as done
,X Mark todo as undone

Or even remap them to somethings more comfortable for you:

# Disable default key bindings
let g:simple_todo_map_keys = 0

# Map your keys
nmap <c-i> <Plug>(simple-todo-new)
imap <c-i> <Plug>(simple-todo-new)
# ...etc.

See :help simple-todo-maps for list of available mappings.

You can also change the tick symbol to something else. Default is x.

let g:simple_todo_tick_symbol = 'y'

Issues

Don't hesitate to open GitHub Issues for any bug or suggestions.

Copyright

Copyright © 2012 Vital Kudzelka. Use it for Good not Evil.

Distributed under the MIT license.

vim-simple-todo's People

Contributors

vitalk avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.