# Obsidian BetterVim

This plugin adds some handy features to obsidians built in vim mode.

## Features:

- Vim yank highlight (inspired by [aleksey-rowan/obsidian-vim-yank-highlight](https://github.com/aleksey-rowan/obsidian-vim-yank-highlight))
- insert bullet point on new line
- sync system clipboard (yank & paste)
- visual-line motions for j/k/0/$/_/A/I/V (optional)

If you miss a feature please open a issue.

## Plans:

- I intend to integrate something like [nvim-mini/mini.surround](https://github.com/nvim-mini/mini.surround)

## Releases (Changesets)

This repo uses Changesets. Add a changeset in your PR with `pnpm changeset`. When the PR merges to `main`, the release workflow versions the plugin, updates `manifest.json`/`versions.json`, tags `x.x.x`, and creates the GitHub release automatically.

## Installation

### Community Plugins

1. Open Obsidian.
2. Go to "Settings" > "Community plugins."
3. Search for "Better Vim"
4. Click "Install" to enable the plugin.

### Manual Installation

1. Download the latest release from the [Releases](https://github.com/NilsGke/obsidian-better-vim/releases) page.
2. Extract the zip file into your Obsidian plugins folder.
3. Reload Obsidian to activate the plugin.

## License

This project is licensed under the [MIT License](LICENSE).