https://github.com/lukaszkorecki/workflowish

A todo "plugin" for Vim, inspired by https://workflowy.com/
https://github.com/lukaszkorecki/workflowish

Last synced: 15 days ago
JSON representation

A todo "plugin" for Vim, inspired by https://workflowy.com/

• Host: GitHub
• URL: https://github.com/lukaszkorecki/workflowish
• Owner: lukaszkorecki
• License: mit
• Created: 2012-03-02T20:47:15.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-09-23T03:32:57.000Z (about 6 years ago)
• Last Synced: 2024-10-10T11:26:09.119Z (27 days ago)
• Language: VimL
• Homepage: http://www.vim.org/scripts/script.php?script_id=3959
• Size: 21.5 KB
• Stars: 122
• Watchers: 9
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
# Workflowish

[![Build Status](https://travis-ci.org/flugsio/workflowish.png)](https://travis-ci.org/flugsio/workflowish)

Simple TODO list plugin for Vim, inspired by [Workflowy.com](https://workflowy.com/)

## Screenshot

![vimshot](http://f.cl.ly/items/3A1n1J1e3m1R2u463a1t/Screen%20shot%202012-03-03%20at%2017.45.35.png)

## Why?

It started with a [tweet](https://twitter.com/#!/lukaszkorecki/status/175637968348917760)

![tweetshot](http://f.cl.ly/items/1M21383X350K3k0j1j2O/Screen%20shot%202012-03-03%20at%2017.15.00.png)

Here's what was "attached":

    # vi: fen foldmethod=indent :

    * lol

      * lol

        * wat

        * wut

    +---  2 lines: * wee ------------------------------------------------------

        * meh

      * ouch

Then I started hacking on a little plugin-ish thing and came up with `workflowish`

![folded](http://f.cl.ly/items/2G3d070b2c3u0m302X0j/Screen%20shot%202012-03-03%20at%2017.08.50.png)

# How?

By defining a simple syntax in Vim and using brilliant [folding capabilities](http://vim.wikia.com/wiki/Folding) *workflowish* can simulate 99% of *Workflowy's* features.

### Features?

- searching (Vim is pretty good at it)

- deleting (as above)

- folding and a `zoom/focus` mode

  - `zq` to focus on current item / toggle off

  - `zp` move focus to parent item

  - `za` toggles folding. See [Vim wiki: Folding](http://vim.wikia.com/wiki/Folding#Opening_and_closing_folds)

- notes (just add `\` in the beginning of the line to start a comment)

- [vimgrep](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep) for filtering lines

- todos:

  - a todo which is not completed is a line which starts with `*`

  - completed todo starts with a `-`

- convert from workflowy plain text export

  - in a `.wofl` file or after `:set ft=workflowish`, run `:call workflowish#convert_from_workflowy()` to convert the whole buffer

- split windows in vim makes it easy to organize big lists

Thanks to the long running tradition, *workflowish* files have `.wofl` extension.

## Installing

[Use Tim Pope's Pathogen](https://github.com/tpope/vim-pathogen).

> New to Pathogen? It's easy. You "install a plugin" by putting its files in a directory. i.e. `cd ~/.vim/bundle && git clone https://github.com/lukaszkorecki/workflowish` but please, [read the Pathogen README](https://github.com/tpope/vim-pathogen).)

## Optional configuration tweak

This is not necessary for most users, but if you're a perfectionist you can do it. Add this to your .vimrc to fix [an edge-case with folding single-items](https://github.com/lukaszkorecki/workflowish/issues/5):

```

autocmd BufWinLeave *.wofl mkview

autocmd BufWinEnter *.wofl silent loadview

```

# Legal

MIT  (c) Workflowish Team

## Maintainers

   15 Jimmie Elvenmark

   10 Łukasz Korecki

    4 hangtwentyy