Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koralowiec/enhanced-vim-in-obsidian
Get better Vim mode in Obsidian
https://github.com/koralowiec/enhanced-vim-in-obsidian
Last synced: about 23 hours ago
JSON representation
Get better Vim mode in Obsidian
- Host: GitHub
- URL: https://github.com/koralowiec/enhanced-vim-in-obsidian
- Owner: koralowiec
- License: mit
- Created: 2024-06-17T17:18:14.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-24T15:19:19.000Z (5 months ago)
- Last Synced: 2024-06-24T17:12:31.311Z (5 months ago)
- Language: Shell
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Enhanced Vim mode in Obsidian
Obsidian is shipped with Vim keybindings support, but it's not perfect. I noticed some annoyances while using it, so I decided to improve it a little bit
This repository contains some adjustments (defined in `app-adjustments.json` and `hotkeys-adjustments.json`), `.obsidian.vimrc` file (with some additional hotkeys and configuration), and `vimify.sh` script (for adding these modifications to an Obsidian Vault)
### Setup
1. Make sure that `jq` is available on your system
2. Make sure that community plugins are turned on (in your Vault's Settings)
3. Install and enable [Vimrc Support](https://github.com/esm7/obsidian-vimrc-support) plugin
4. Clone the repo
5. Run `vimify.sh` script with path to your vault as the first argument:
```bash
./vimify.sh "/home/arek/.config/obsidian/Obsidian Sandbox"
```
6. Restart your Obsidian
#### Additional setup
1. If you like relative line numbers, install [Relative Line Numbers](https://github.com/nadavspi/obsidian-relative-line-numbers) plugin
#### More about the script
The script makes copies of the files (`app.json`, `hotkeys.json` and `.obsidian.vimrc`) before modifying them!
You can easily revert them back. For example:
```bash
cp \
"/.obsidian/app.json-2024-06-11T15:18:46UTC.bak"
"/.obsidian/app.json"
```
### Hotkeys
Changes within the default hotkeys:
| Command | | Default hotkey | New hotkey | Comment |
| ----------------- | ----------------------- | -------------- | ---------- | --------------------------------- |
| Close Current Tab | workspace:close | Ctrl+w | Ctrl+q | Ctrl+w can be used to delete word |
| Delete Paragraph | editor:delete-paragraph | Ctrl+d | | Ctrl+d can be used to jump down |
Additional hotkeys defined in `.obsidian.vimrc`:
| Action | Hotkey | Comment |
| ---------------------- | ------ | -------------------------------------------- |
| Open Previous Tab | gT | Default in Vim |
| Open Previous Tab | J | Hotkey in Vimium browser extension |
| Open Next Tab | gt | Default in Vim |
| Open Next Tab | H | Hotkey in Vimium browser extension |
| Navigate Back | Alt+h | |
| Navigate Forward | Alt+l | |
| Close and Save | ZZ | Default in Vim |
| Open File Explorer | ff | |
| Follow Link | gd | Often used as Go to Definition in Vim setups |
| Follow Link in New Tab | gD | Often used as Go to Definition in Vim setups |
| Follow Link in Split | gS | |
| Open New Tab | t | Hotkey in Vimium browser extension |
### Additional configuration
`.obsidian.vimrc` additionally sets up:
- Yanking to system clipboard with `y` (by setting clipboard to `unnamedplus`)