https://github.com/tirthd16/dockeys
Vim navigation in Google Docs
https://github.com/tirthd16/dockeys
chrome-extension google-docs vim
Last synced: 18 days ago
JSON representation
Vim navigation in Google Docs
- Host: GitHub
- URL: https://github.com/tirthd16/dockeys
- Owner: tirthd16
- License: mit
- Created: 2024-10-28T10:28:49.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T03:33:54.000Z (about 2 months ago)
- Last Synced: 2025-02-24T04:23:30.809Z (about 2 months ago)
- Topics: chrome-extension, google-docs, vim
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/docskeys/mmmomengbindngnkjblabjebdfmaiccj
- Size: 32.2 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
# DocsKeys
A browser extension that brings Vim-style keyboard shortcuts to Google Docs, allowing you to edit documents with familiar Vim motions and commands.
While this extension currently implements core Vim functionality including basic motions, text manipulation, and visual selections, there's room for expansion. Contributions are welcome to add more Vim features as per your need.
If you are using DocsKeys with Vimium, disable Vimium on Google Docs.
This project is heavily inspired by and uses much of code from [SheetKeys](https://github.com/philc/sheetkeys)
### Available Motions
#### Basic Movement
- `h` - Move cursor left
- `j` - Move cursor down
- `k` - Move cursor up
- `l` - Move cursor right
- `w` - Move to start of next word
- `b` - Move to start of previous word
#### Line Navigation
- `0` or `^` or `_` - Go to start of line
- `$` - Go to end of line
- `I` - Go to start of line and enter insert mode
- `A` - Go to end of line and enter insert mode
#### Document Navigation
- `g` - Go to document start
- `G` - Go to document end
- `{` - Go to start of paragraph
- `}` - Go to end of paragraph
### Editing Commands
#### Mode Switching
- `i` - Enter insert mode
- `a` - Enter insert mode (after cursor)
- `v` - Enter visual mode
- `V` - Enter visual line mode
- `Esc` - Return to normal mode
- `Ctrl` + `o` - Temporary normal mode from insert mode
#### Text Manipulation
- `d` + motion - Delete (supports `dw`, `diw`, `dp`, `dip`, `dd`)
- `c` + motion - Change (supports `cw`, `ciw`, `cp`, `cip`, `cc`)
- `y` + motion - Yank/copy (supports `yw`, `yiw`, `yp`, `yip`, `yy`)
- `p` - Paste
- `u` - Undo
- `r` - Redo
#### Line Operations
- `o` - Add new line below and enter insert mode
- `O` - Add new line above and enter insert mode
### Visual Mode Commands
When in visual mode (`v` or `V`):
- All movement keys (`h`, `j`, `k`, `l`, `w`, `b`, etc.) extend the selection
- `d` - Delete selected text
- `c` - Change selected text
- `y` - Yank selected text
- `p` - Paste over selected text
## Installation
[Chrome Web Store](https://chromewebstore.google.com/detail/docskeys/mmmomengbindngnkjblabjebdfmaiccj) |
[Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/docskeys/)
Install from source
- Check out this repository
- Navigate to chrome://extensions in Chrome
- Toggle into Developer Mode
- Click on "Load Unpacked Extension..."
- Select the docskeys folder
## Usage
1. Open a Google Doc
2. Extension will automatically activate
3. Start using Vim commands in normal mode
4. Press `i` or `a` to enter insert mode for regular typing
5. Press `Esc` to return to normal mode
## Known Limitations
- Most advanced Vim features like marks, macros, and registers are not supported
- Custom key mappings are not supported
- PR's are welcome to add these features
## License
See [MIT-LICENSE.txt](MIT-LICENSE.txt) for details.