Git Product home page Git Product logo

vimflowy's Introduction

Vimflowy Vimflowy

Join Gitter chat Build Status

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

Try it out!

(Video coming eventually...)

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/export
    • loads data lazily (good for huge documents)
    • search (not like vim's)
    • cloning (bullets duplicated in multiple locations in a document)
    • different visual themes

LIMITATIONS

  • Tested mostly in recent Chrome and Firefox. You may need a relatively modern browser.
  • No collaborative editing
  • Global search is slow for large documents (so you'll want to use marks)

DATA STORAGE

Vimflowy was designed to work with multiple storage backends.

Local

By default, the app is entirely local meaning:

  • Your data is never sent over the internet, so you can only use it in one browser on one device
  • Vimflowy works offline

It uses HTML5's localStorage, so:

  • If you're going to have a very large document, use a browser with large localStorage limits, e.g. Firefox
  • Be warned that if you don't set up remote storage, clearing localStorage will result in you losing all your data!

Remote

If you enable a remote storage backend, then:

  • You can access your document from multiple devices
  • You cannot edit offline

Currently, the only storage backend implemented is Firebase. See here for details on how to set this up.

Please contact the dev team if you are interested in other storage backends.

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

vimflowy's People

Contributors

wuthefwasthat avatar za3k avatar tarnas14 avatar alxgnon avatar fullyint avatar dragonaire avatar amuelli avatar gitter-badger avatar

Watchers

James Cloos avatar Alexey Shulga 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.