Skip to content
@vimeejs

vimee

" g:vimee (/ˈvaɪ.miː/) = vim + engine + ecosystem
vimee

vimee

A headless Vim engine for the web

CI License: MIT


vimee is a framework-agnostic, pure-function Vim engine with zero runtime dependencies. It takes a keystroke and returns state transitions — no DOM, no side effects. Framework bindings turn those transitions into reactive state.

Packages

Package Description npm
@vimee/core Headless Vim engine with pure function API npm
@vimee/react React useVim hook npm
@vimee/shiki-editor Vim editor with Shiki syntax highlighting npm
@vimee/plugin-textarea Attach Vim to any textarea npm
@vimee/plugin-monaco Attach Vim to Monaco Editor npm
@vimee/plugin-codemirror Attach Vim to CodeMirror 6 npm
@vimee/testkit Test utilities for Vim operations npm

Repositories

Repository Description
vimee Core monorepo — engine, bindings, editor, testkit
playground Live demo app for trying vimee in the browser
website Project website at vimee.dev
opengraph Procedural OGP image generator

Quick Start

npm install @vimee/core @vimee/react @vimee/shiki-editor shiki
import { Vim } from "@vimee/shiki-editor";
import "@vimee/shiki-editor/styles.css";

<Vim
  content={`const greeting = "Hello, vim!";`}
  highlighter={highlighter}
  lang="typescript"
  theme="vitesse-dark"
/>

Contributing

We welcome contributions! See the Contributing Guide and Code of Conduct.

License

MIT

Pinned Loading

  1. vimee vimee Public

    👻 A headless vim engine for the web

    TypeScript 18

  2. playground playground Public

    playground for vimee

    TypeScript

Repositories

Showing 5 of 5 repositories

Top languages

Loading…

Most used topics

Loading…