hanyelC / kickstart.vim

A launch point for your personal vim configuration (Vimscript version of https://github.com/nvim-lua/kickstart.nvim)

kickstart.vim

Introduction

Kickstart.vim is a Vimscript version of Kickstart.nvim. Like Kickstart.nvim, Kickstart.vim strives to be:

A starting point for Neovim Vim that is:

• Small
• Single-file (with examples of moving to multi-file)
• Documented
• Modular

Installation

Note

I highly recommend you to fork this repo so that you can manage your own configuration

Option #1: Manually copying and pasting the contents of the .vimrc

Option #2: Creating a symbolic link

This is an easy way to manage your Vimrc with Git as well as other configuration files.

0. Backup your existing .vimrc (e.g., mv ~/.vimrc ~/.old-vimrc.bak)
1. clone the repository in your home directory

   # Replace `theopn/kickstart.vim` with `your-username/forked-repository-name` if you made a fork
   git clone https://github.com/theopn/kickstart.vim.git ~/kickstart.vim

2. Create a symbolic link between ~/kickstart.vim/.vimrc and ~/.vimrc

   # Make sure you have backed up existing .vimrc
   # The force flag (-f) will overwrite the existing file
   ln -sf ~/kickstart.vim/.vimrc ~/.vimrc

3. Now whenever you open ~/.vimrc, you are opening ~/kickstart.vim/.vimrc. Since kickstart.vim is a Git repository, you can easily manage changes you made to your .vimrc across multiple devices.

Post Installation

Run the following command and launch Vim again, and you are ready to go!

vim +PlugInstall +qa

Changes from Kickstart.nvim

kickstart.vim:

• is written in Vimscript (:surprised Pikachu face:) and designed for Vim >= 0.8
• uses Vim alternative for the following plugins
  • lazy.nvim -> vim-plug
  • nvim-lspconfig and other LSP plugins -> vim-lsp
  • nvim-cmp -> supertab
  • which-key.nvim -> vim-which-key
  • gitsigns.nvim -> vim-gitgutter
  • onedark.nvim -> onedark.vim
  • lualine.nvim -> vim-airline
  • indent-blankline.nvim -> indentLine
  • Comment.nvim -> vim-commentary
  • telescope.nvim -> fzf & fzf.vim
• enables some settings enabled by default in Neovim (e.g., filetype, syntax, autoindent, etc.) on the top of kickstart.nvim settings
• enables hlsearch
• disables undofile by default, but the instructions for changing undodir and enabling undofile are included
• does not provide an alternative for:
  • highlight on yank
  • nvim-treesitter