https://github.com/WuTheFWasThat/vimflowy

An open source productivity tool drawing inspiration from workflowy and vim
https://github.com/WuTheFWasThat/vimflowy

productivity typescript vim workflowy

Last synced: 3 months ago
JSON representation

An open source productivity tool drawing inspiration from workflowy and vim

• Host: GitHub
• URL: https://github.com/WuTheFWasThat/vimflowy
• Owner: WuTheFWasThat
• License: mit
• Created: 2015-05-07T17:30:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:33:32.000Z (about 2 years ago)
• Last Synced: 2024-10-15T23:44:49.279Z (3 months ago)
• Topics: productivity, typescript, vim, workflowy
• Language: TypeScript
• Homepage: https://www.wuthejeff.com/vimflowy
• Size: 4.98 MB
• Stars: 1,600
• Watchers: 38
• Forks: 111
• Open Issues: 73
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - WuTheFWasThat/vimflowy - An open source productivity tool drawing inspiration from workflowy and vim (TypeScript)

README

        
# ![Vimflowy](/static/images/vimflowy-32.png?raw=true) Vimflowy

[![Build Status](https://travis-ci.org/WuTheFWasThat/vimflowy.svg?branch=master)](https://travis-ci.org/WuTheFWasThat/vimflowy?branch=master)

NOTE: I don't have time to maintain this anymore, sorry!

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

[Try it out now!](https://www.wuthejeff.com/vimflowy)

[Deploy yourself with docker!](https://hub.docker.com/r/vimflowy/vimflowy/)

## 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](docs/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](docs/storage/README.md).

### SELF-HOSTING

See the [deployment documentation](docs/deployment.md) for details.

You can deploy with docker, or build from source yourself.

## NOTES FOR DEVELOPERS

Contributions are very welcome!

See [dev_setup.md](docs/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](docs/FAQ.md)