How do I build Vim.js from source?

Follow the build.sh script after setting up emscripten with ASYNCIFY enabled, GCC, and cproto. Be prepared for high memory usage during compilation, as noted in the README tips.

Vim.js vs Vimium: which is better for browser editing?

Vim.js is a full port of Vim for editing text within web pages, with persistent configuration. Vimium is a browser extension for navigation shortcuts, not a text editor.

Can I use my existing .vimrc with Vim.js?

Yes, Vim.js supports persistent ~/.vimrc; you can edit it via :e $VIM/vimrc and settings are saved across sessions, maintaining your custom Vim environment.

Does Vim.js support Vim plugins?

The README doesn't mention plugin support; given the small feature set and web constraints, it likely has limited or no compatibility with traditional Vim plugins.

What browsers work best with Vim.js?

Firefox, Chrome, and IE are recommended due to better ASM.js optimization. Performance may vary in other browsers, especially those without ASM.js support.

How to access files from Dropbox in Vim.js?

Vim.js has built-in Dropbox integration; you can read files directly from Dropbox cloud storage, enabling editing of cloud-saved documents within the editor.

Open-Awesome

vim.js

NOASSERTIONC

A JavaScript port of Vim that runs in web browsers with ASM.js, persistent configuration, and local file access.

Visit Website GitHub

4.4k stars265 forks0 contributors

What is vim.js?

Vim.js is a JavaScript port of the Vim text editor that runs in web browsers using ASM.js compilation. It provides the core Vim editing experience with modal editing, commands, and configuration while enabling integration with web technologies like JavaScript execution and cloud storage access. The project solves the problem of bringing powerful terminal-based text editing to browser environments.

Target Audience

Vim users who want to edit text in web browsers with familiar Vim keybindings, and developers interested in porting complex C applications to the web using Emscripten and ASM.js.

Value Proposition

Developers choose Vim.js because it offers the most authentic Vim experience available in a browser, with persistent configuration, local file access, and the ability to execute JavaScript from within the editor. Unlike simple Vim keybinding libraries, it's an actual port of Vim with its full editing engine.

Overview

JavaScript port of Vim

Use Cases

Best For

Using Vim keybindings for text editing directly in web browsers
Experimenting with porting complex C applications to JavaScript via Emscripten
Editing configuration files or code snippets in browser-based development environments
Accessing and editing files from Dropbox using Vim commands
Learning about ASM.js performance optimization for web applications
Creating browser extensions that provide Vim editing capabilities

Not Ideal For

Projects requiring the full Vim feature set for advanced editing workflows, such as syntax highlighting for numerous languages
Teams needing a plug-and-play text editor with minimal setup and configuration effort
Applications targeting browsers without robust ASM.js support or requiring consistent performance across all platforms

Pros & Cons

Pros

ASM.js Performance

Compiled to ASM.js for near-native speed in supported browsers like Firefox and Chrome, enabling smooth modal editing without heavy lag.

Persistent Configuration

Saves ~/.vimrc settings across sessions, allowing users to maintain custom keybindings and preferences as in terminal Vim.

JavaScript Integration

Supports executing JavaScript code directly from within Vim, bridging traditional editing with web-specific functionality and extensions.

Flexible Deployment Options

Available as NW.js desktop app, Firefox extension, and web versions, offering multiple ways to integrate Vim into different environments.

Cons

Complex Build Process

Requires emscripten with ASYNCIFY, GCC, cproto, and high memory, making setup difficult for developers without specialized tooling.

Reduced Feature Set

Uses a small feature set for online demos; the normal Vim feature set is too large and slow, limiting advanced editing capabilities.

Limited Browser Support

Optimized for Firefox, Chrome, and IE; performance and compatibility may degrade in unsupported or older browsers.

Frequently Asked Questions

Related Projects

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility

Stars47,380

Forks3,669

Last commit1 year ago

CodeMirror

In-browser code editor (version 5, legacy)

Stars27,201

Forks4,923

Last commit6 months ago

ace

Ace (Ajax.org Cloud9 Editor)

A React framework for building text editors.

Stars22,565

Forks2,591

Last commit3 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub