Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hezkore/vimod
My unnecessarily complicated Vim configuration
https://github.com/hezkore/vimod
vim vimrc
Last synced: 3 months ago
JSON representation
My unnecessarily complicated Vim configuration
- Host: GitHub
- URL: https://github.com/hezkore/vimod
- Owner: Hezkore
- Created: 2024-07-13T02:00:43.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-09T01:00:12.000Z (5 months ago)
- Last Synced: 2024-10-11T06:01:49.039Z (3 months ago)
- Topics: vim, vimrc
- Language: Vim Script
- Homepage:
- Size: 441 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VIMod⚡
VIMod _(VIM + Vemod)_ is my personal [Vim 9.0+](https://github.com/vim/vim) configuration.
VIMod is designed to complement any existing Vim setup, but works equally well on a fresh Vim install!\
If you ever decide to remove VIMod, your Vim setup will return to its original state.
_VIMod and the Quick UI, reachable by pressing Space._
Learn more about VIMod, and how to use it, on the [Wiki](https://github.com/Hezkore/vimod/wiki).\
_Never used Vim before? Read the [new user](https://github.com/Hezkore/vimod/wiki/New-User) guide to get started._
## Install
Just download and add the runtime!\
OS specific instructions:
Windows
1. Clone the VIMod repository to your local machine:
```shell
git clone https://github.com/hezkore/vimod.git %USERPROFILE%/vimfiles/vimod
```
2. Add the runtime at the top of your `vimrc` file:
```vim
runtime vimod/vimod.vim
```
3. Add the optional [extended keymaps](https://github.com/Hezkore/vimod/wiki#extended-keymaps) below the runtime:
```vim
VIModKeys
```
Unix-based
1. Clone the VIMod repository to your local machine:
```shell
git clone https://github.com/hezkore/vimod.git ~/.vim/vimod
```
2. Add the runtime at the top of your `vimrc` file:
```vim
runtime vimod/vimod.vim
```
3. Add the optional [extended keymaps](https://github.com/Hezkore/vimod/wiki#extended-keymaps) below the runtime:
```vim
VIModKeys
```
Read the [Wiki](https://github.com/Hezkore/vimod/wiki) for instructions on how to use VIMod.
> [!TIP]
> Get a local copy of the wiki pages:
> `git clone https://github.com/Hezkore/vimod.wiki.git`
## Prerequisites
* Vim 9.0+ _(some plugins will not work with older versions)_
* A terminal size of at least 80 columns and 29 rows _(for the Quick UI to display correctly)_
GitHub Integration _(optional)_:
* [GitHub CLI](https://cli.github.com/)
GitHub Copilot _(optional)_:
* GitHub [Copilot Subscription](https://github.com/features/copilot/plans)
* [Node.js](https://nodejs.org)
## Troubleshooting
If you are unsure where your vimrc file is located, run the following command in Vim: `:echo $MYVIMRC`
If you are unsure if the runtime was added correctly, run the following command in Vim: `:VIModVersion`\
If it says "Not an editor command: VIModVersion", the runtime was not added correctly.
VIMod will install and manage all plugins and dependencies automatically when you start Vim for the first time.\
The install screen will automatically close when the installation is complete, so just sit tight and wait for it to finish.\
If it is aborted, VIMod will not function correctly, and you will ned to run `:PlugInstall` manually.
Most errors are due to incorrect plugin installations, so if you encounter any issues, try running `:PlugInstall` and restarting Vim.
## Updating
### VIMod
If Git was used to clone the VIMod repository, you can update VIMod by running the following command in the VIMod directory:
```shell
git pull
```
Otherwise you can download the latest source code and extract it to the VIMod directory.
Remember to always run `:PlugInstall` after an update as plugins may have been changed.
### Plugins
To update all plugins, run the following command in Vim:
```vim
:PlugUpdate
```
## Uninstall
To uninstall VIMod, remove the runtime from your vimrc file and delete the VIMod directory.