Install the core package
npm install @vimee/coreyarn add @vimee/corepnpm add @vimee/corebun add @vimee/coreWith React
If youβre using React, install the React bindings as well:
npm install @vimee/core @vimee/reactyarn add @vimee/core @vimee/reactpnpm add @vimee/core @vimee/reactbun add @vimee/core @vimee/reactWith React Component
For a full-featured editor with syntax highlighting powered by Shiki:
npm install @vimee/core @vimee/react @vimee/shiki-editor shikiyarn add @vimee/core @vimee/react @vimee/shiki-editor shikipnpm add @vimee/core @vimee/react @vimee/shiki-editor shikibun add @vimee/core @vimee/react @vimee/shiki-editor shikiWith an editor plugin
vimee provides several editor plugins for different use cases:
| Package | Description |
|---|---|
@vimee/plugin-textarea | Attach Vim keybindings to any HTML textarea |
@vimee/plugin-monaco | Monaco Editor integration |
@vimee/plugin-codemirror | CodeMirror 6 integration |
Install the one that fits your needs:
npm install @vimee/core @vimee/plugin-textareayarn add @vimee/core @vimee/plugin-textareapnpm add @vimee/core @vimee/plugin-textareabun add @vimee/core @vimee/plugin-textareaRequirements
- Node.js 18+
- TypeScript 5.0+ (recommended)