Git Product home page Git Product logo

vim-bujo's Introduction

vim-bujo

This plugin allows people to easily access and manage todo lists for their projects from vim.

You can easily access and manage Todo lists of specific projects or a general Todo list.

Installation

If you use a plugin manager, such as vim-plug, follow its instructions on how to install plugins from github.

To install the stable version of the plugin, if using vim-plug, put this in your vimrc/init.vim:

Plug 'vuciv/vim-bujo'

Use / Mappings

  • Open Todo of current git repo:

    :Todo // from git repo
    
  • Open general Todo:

    :Todo g
    
  • Using mods:

    :botright Todo
    :botright Todo g
    

You can see more mod commands at :h mods

  • Insert a new task:

    nmap <C-S> <Plug>BujoAddnormal
    imap <C-S> <Plug>BujoAddinsert
    
  • Check off a task:

    nmap <C-Q> <Plug>BujoChecknormal
    imap <C-Q> <Plug>BujoCheckinsert
    
  • Change cache directory:

    let g:bujo#todo_file_path = $HOME . "/.cache/bujo"
    
  • Change todo window width:

    let g:bujo#window_width = 40
    
    • Press Ctrl-W n < replace n with the number of steps you want to move to the left
    • Press Ctrl-W n > replace n with the number of steps you want to move to the right

Screenshots

This gif shows how the Todo list opens up in vim.

Gif of Bujo use

We can also see that the task list is very easy to manage.

The ascii art is inserted manually, but you can do that yourself with the file 'templates/md.skeleton'

Notes

Feedback and bug reports are welcomed and encouraged. If you want new features, please do let me know. I would be honored at the opportunity to make a tool better for the community.

I built this because I wanted the ease of vim bindings with the benefits of keeping a todo list on hand. It is very simple and minimialist.

I plan to add diary capabilities, and all the fun little quotes and activities that make actual bullet journaling fun!

If you would like to work on this project with me, please reach out to me on twitter

License

Copyright (c) Jersey Fonseca. Distributed under the same terms as Vim itself. See :help license.

vim-bujo's People

Contributors

ahmedselim2017 avatar guidanoli avatar rassska avatar vuciv 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.