An open source productivity tool drawing inspiration from workflowy and vim
TypeScript Other
Clone or download
Latest commit 03feed4 Jun 27, 2018

README.md

Vimflowy Vimflowy

Join Gitter chat Build Status

This is a productivity tool which draws some inspiration from workflowy and vim.

Try it out now!

Deploy yourself with docker!

FEATURES

  • Workflowy features
    • tree-like outlining
    • collapsing and zooming into bullets
    • basic text formatting, strike through task completion
  • Vim features
    • (configurable) vim keybindings
    • modal editing
    • undo history, location history, macros, etc.
  • Plugins system (see plugins.md)
    • marks (not like vim's)
    • easy-motion for moving between bullets quickly
    • time tracking
    • LaTeX and HTML rendering
  • Other
    • data import from or export as text file (native Vimflowy format or Workflowy-compatible format)
    • loads data lazily (good for huge documents)
    • search (not like vim's)
    • cloning (bullets duplicated in multiple locations in a document)
    • customizable visual themes

LIMITATIONS

  • No collaborative editing
  • Global search is slow for large documents (so you'll want to use marks)
  • You may need a relatively modern browser (minimally HTML5 LocalStorage and Flexbox). I test only in recent versions of Chrome and Firefox.

DATA STORAGE

Vimflowy was designed to work with multiple storage backends.

By default, you own your own data, as it is stored locally on your computer. However, you can let Google host it for you, or host it yourself.

See here for more info.

SELF-HOSTING

See the deployment documentation for details. You can deploy with docker, or build from source yourself.

NOTES FOR DEVELOPERS

Contributions are very welcome! See dev_setup.md to see how to get started with a development setup.

LICENSE

MIT: https://wuthefwasthat.mit-license.org/

FAQ (AKA questions I imagine people would ask me)

see here