Skip to content

apemost/vimrc

Repository files navigation

Andrew's vimrc

Codacy Badge Unit Tests Platform PRs Welcome

A simple but powerful vim configuration, continually used and tweaked since 2017.

Screenshot of Vim

Trying with Docker

docker run -it --rm apemost/dotfiles vim

Installation

You can clone this repository wherever you want. To install, run command:

git clone https://github.com/apemost/vimrc.git && cd vimrc && source bootstrap.sh

To update, cd into your local vimrc repository and then:

source bootstrap.sh

Setting up for the first time

We will automatically setting up the vim-plug plugin manager when you open vim for the first time.

Then, you can:

  • run :PlugInstall to install the plugins
  • run :PlugUpdate to update the plugins
  • see tutorial page to learn the basics of vim-plug

Adding your own customization

To conveniently add your own customization, copy vimrc.preload to ~/.vimrc.preload, and vimrc.afterload to ~/.vimrc.afterlaod.

Changing the default color scheme

Edit ~/.vimrc.preload:

let g:custom_background = 'light'
let g:custom_colorscheme = 'solarized'

Enable completion and lint plugins

The completion and lint plugins are disabled by default. To enable them, edit ~/.vimrc.preload:

let g:custom_completion_plugin = 'youcompleteme'
let g:custom_lint_plugin = 'ale'

Adding your plugins

Edit ~/.vimrc.preload:

let g:custom_plugins = [
      \   ['NLKNguyen/papercolor-theme'],
      \ ]

Reload .vimrc and run :PlugInstall.

Disable built-in plugins

Edit ~/.vimrc.preload:

let g:custom_disabled_plugins = [
      \   'sneak',
      \   'go',
      \ ]

Consistent experience for IdeaVim

Link the ideavimrc to ~/.ideavimrc:

ln -s "$PWD/ideavimrc" ~/.ideavimrc

Or:

cp ideavimrc ~/.ideavimrc

Consistent experience for VSCodeVim

Copy the content of vscodevim.json to your VS Code configuration file such as settings.json.

Uninstallation

Run rm ~/.vimrc.

FAQ

How dare you remap s?

You can specify any mapping for Sneak (see :help sneak). By the way: cl is equivalent to s, and cc is equivalent to S.

See https://github.com/justinmk/vim-sneak#how-dare-you-remap-s

To disable Sneak, see Disable built-in plugins

Contributing

All contributions are welcome! If you would like to hack on this work, please follow these steps:

  1. Fork this repository
  2. Make your changes
  3. Submit a pull request

License

MIT

Releases

No releases published

Packages

No packages published