VIMrly is a Chrome Extension that integrates Vim-style keyboard shortcuts into Google Docs, enhancing text editing efficiency and user productivity. Built and tested using TypeScript, Webpack, and Jest. Initially developed collaboratively during the DevelopEd 3.0 Hackathon (2024) 🏆 and further advanced 🚀, VIMrly aims to provide a seamless modal editing experience for Vim enthusiasts working within Google Docs.
- Vim-like Navigation: Utilize
h,j,k,lkeys for efficient cursor movement within documents, and many other Vim commands! - Modal Editing: Switch between Command, Insert, and Visual modes to control editing behavior.
- Status Bar: A dynamic status bar at the bottom displays the current mode for real-time feedback.
- Settings Popup: Customize extension settings, such as enabling or disabling specific modes, through an intuitive popup interface.
- Seamless Integration: Designed to work harmoniously with Google Docs without disrupting native functionalities.
Screen.Recording.2025-01-27.at.10.51.21.AM.mov
- Google Chrome: Ensure you have the latest version of Google Chrome installed.
- Node.js and npm: Required for building the extension from source.
-
Clone the Repository:
git clone https://github.com/andynapoleon/VIMrly.git cd VIMrly -
Install Dependencies:
npm install- Build the Extension:
npm run build- This command compiles the TypeScript files, bundles the scripts and styles, and copies necessary assets into the
dist/directory.
- Load the Extension into Chrome:
- Open Chrome and navigate to
chrome://extensions/. - Enable Developer mode by toggling the switch on the top right corner.
- Click on Load unpacked and select the
dist/folder from the cloned repository. - The VIMrly extension should now appear in your list of extensions and its icon in the Chrome toolbar.
Developed by:
- Andy Tran (anhquoctran006@gmail.com)
- Viet Chu (vchu1@ualberta.ca)