Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matthewsot/docs-vim
Use Google Docs like vim. Sorta.
https://github.com/matthewsot/docs-vim
google-docs vim
Last synced: 3 months ago
JSON representation
Use Google Docs like vim. Sorta.
- Host: GitHub
- URL: https://github.com/matthewsot/docs-vim
- Owner: matthewsot
- License: mit
- Created: 2017-12-05T23:52:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-06T03:58:16.000Z (over 3 years ago)
- Last Synced: 2024-10-24T21:38:17.916Z (3 months ago)
- Topics: google-docs, vim
- Language: JavaScript
- Homepage:
- Size: 85.9 KB
- Stars: 117
- Watchers: 10
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docs-vim
## Installation (Chrome)
```
git clone https://github.com/matthewsot/docs-vim.git
cd docs-vim
git submodule init
git submodule update
```
* Go to `chrome://extensions/` in Chrome or Chromium.
* Enable "Developer Mode". (Right top of the screen)
* Click "Load unpacked". (Left top of the screen)
* Select the docs-vim folder and click "Open"
## Update
Apparently Google is [making significant changes to the Docs
editor](https://workspaceupdates.googleblog.com/2021/05/Google-Docs-Canvas-Based-Rendering-Update.html),
so this will likely stop working in the next few months.
## Overview
This simulates very limited versions of vim's insert and normal modes on Google
Docs.
Currently supported features:
* Insert mode:
* Typing
* Escaping to normal with Esc
* Escaping to normal with a two-key combination
* Normal mode
* Getting to insert mode with the "i" key
* Moving with the home-row keys
* Repeated motions using the number keys
* Delete a single character with the "x" key
* Enter visual mode with the "v" key
* Visual mode
* Getting to normal mode with Esc
* Moving with the home-row keys
* Repeated motions using the number keys
* Delete selected text with the "x" key
* Chrome (tested on 63.0)
* (Not really) Firefox
* It will install, but many of the features work incorrectly.
## How?
Glad you asked - this project is built with the [docs-plus
library](https://github.com/matthewsot/docs-plus), which enables rich
interactions with the Google Docs editor. Improvements made to the library here
(particularly those in the ``docs-plus-plus.js`` file) will probably eventually
be pushed back up to the main docs-plus library.
## Keys
Currently set up to work with my DVORAK layout, these are the default keybindings:
* Insert Mode:
* Esc: enter normal mode
* hn: enter normal mode
* Normal Mode:
* i: enter insert mode
* dhtn: move
Note that most of these can be changed in ``docs-vim.js``. For example, if you
want to use the more common QWERTY keybindings, you'd change to:
```
vim = {
...
"keys": {
"move": "hjkl",
"escapeSeq": "jk",
}
};
```
Near the top of ``docs-vim.js``.
## Future Features
I don't really use all that much of vim's shortcuts, but a few particular things I want to add
eventually:
* Selections with shift-V (visual line mode)
* Command mode with find and replace, go to line #, etc.
* Quick find with /