The Ultimate NeoVim Config for Colemak Users

中文版

Please DO NOT just copy this configuration folder without really looking at it! Please, at least, read this README file!

• Requirements
• After Installation, You Need To
• After Installation, You Might Want To
  • First of all
  • For Python Debugger (via vimspector)
  • Config Python path
  • For Taglist:
  • For FZF
  • And also...
• Keyboard Shortcuts
  • 1 Basic Editor Features
    • 1.1 The Most Basics
    • 1.2 Remapped Cursor Movement
    • 1.3 Remapped Insert Mode Keys
    • 1.4 Remapped Text Manipulating Commands in Normal Mode
    • 1.5 Other Useful Normal Mode Remappings
    • 1.6 Remapped Commands in Visual Mode
  • 2 Window Management
    • 2.1 Creating Window Through Split Screen
    • 2.2 Moving the Cursor Between Different Windows
    • 2.3 Resizing Different Windows
    • 2.4 Closing Windows
  • 3 Tab Management
  • 4 Terminal Keyboard Shortcuts
• Plugins Keybindings (Screenshots/GIF provided!)
  • AutoCompletion
    • COC (AutoCompletion)
    • coc-snippets
  • File Navigation
    • coc-explorer (file browser)
    • rnvimr - file browser
    • FZF - the fuzzy file finder
    • xtabline (the fancy tab line)
  • Text Editing Plugins
    • vim-table-mode
    • Undotree
    • vim-visual-multi
    • vim-surround
    • vim-subversive
    • vim-easy-align
    • AutoFormat
    • vim-markdown-toc (generate table of contents for markdown files)
  • Navigation Within Buffer
    • Vista.vim
  • Find and Replace
    • Far.vim - find and replace
  • Git Related
    • vim-gitgutter
    • fzf-gitignore
  • Others
    • vim-calendar
    • Goyo - Work without distraction
    • suda.vim
    • coc-translator
• Custom Snippets
  • Markdown
• Some Weird Stuff
  • Press tx and enter your text
  • Customized Vertical Cursor Movement

Requirements

• This nvim configuration REQUIRES NeoVim 0.6.0+

After Installation, You Need To

• Install pip3, and do pip3 install --user pynvim
• Install node, and do npm install -g neovim
• Install nerd-fonts (actually it's optional but it looks real good)

After Installation, You Might Want To

First of all

• Do :checkhealth

For Python Debugger (via vimspector)

• Install debugpy (pip)

Config Python path

• Well, make sure you have python
• See _machine_specific.vim

For Taglist:

• Install ctags for function/class/variable list

For FZF

• Install fzf
• Install ag (the_silver_searcher)

And also...

• Install figlet for inputing text ASCII art
• Install xclip for system clipboard access (Linux and xorg only)

Keyboard Shortcuts

1 Basic Editor Features

1.1 The Most Basics

k : switchs to INSERT : mode (same as key i in vanilla vim)

Q : quits current vim window (same as command :q in vanilla vim)

S : saves the current file (same as command :w in vanilla vim)

IMPORTANT

Since the i key has been mapped to k, every command (combination) that involves i should use k instead (for example, ciw should be ckw).

1.2 Remapped Cursor Movement

1.3 Remapped Insert Mode Keys

1.4 Remapped Text Manipulating Commands in Normal Mode

1.5 Other Useful Normal Mode Remappings

1.6 Remapped Commands in Visual Mode

2 Window Management

2.1 Creating Window Through Split Screen

2.2 Moving the Cursor Between Different Windows

2.3 Resizing Different Windows

Use the arrow keys to resize the current window.

2.4 Closing Windows

3 Tab Management

4 Terminal Keyboard Shortcuts

Plugins Keybindings (Screenshots/GIF provided!)

AutoCompletion

COC (AutoCompletion)

coc-snippets

File Navigation

coc-explorer (file browser)

rnvimr - file browser

• Make sure you have ranger installed

Press R to open Ranger (file selector)

And Within rnvimr (ranger), you can:

FZF - the fuzzy file finder

xtabline (the fancy tab line)

Text Editing Plugins

vim-table-mode

See :help table-mode.txt for more.

Undotree

vim-visual-multi

vim-surround

To add surround (string -> "string"):

string

press: yskw':

'string'

To change surround

'string'

press: cs'":

"string"

vim-subversive

New operator: s:

You can execute s<motion> to substitute the text object provided by the motion with the contents of the default register (or an explicit register if provided). For example, you could execute skw to replace the current word under the cursor with the current yank, or skp to replace the paragraph, etc.

vim-easy-align

Press ga + symbol in normal or visual mode to align text based on symbol

AutoFormat

Press \ f to format code

vim-markdown-toc (generate table of contents for markdown files)

In markdown files, type :Gen then tab, you'll see your options.

Navigation Within Buffer

Vista.vim

Press T to toggle function and variable list

Find and Replace

Far.vim - find and replace

Press SPACE f r to search in cwd.

Git Related

vim-gitgutter

fzf-gitignore

Press Space g i to create a .gitignore file

Others

vim-calendar

Goyo - Work without distraction

Press g y to toggle Goyo

suda.vim

Forgot to sudo vim ...? Just do :sudowrite or :sw

coc-translator

Press ts to translate word under cursor.

Custom Snippets

Markdown

,f to go to the next <++> (placeholder)

,w to go to the next <++> (placeholder) and then press Enter for you

Some Weird Stuff

Press tx and enter your text

tx Hello<Enter>

 _   _      _ _
| | | | ___| | | ___
| |_| |/ _ \ | |/ _ \
|  _  |  __/ | | (_) |
|_| |_|\___|_|_|\___/

Customized Vertical Cursor Movement

This NeoVim configuration includes a customized vertical cursor movement tailored for Colemak users. It can be located in cursor.vim, and it serves as an alternative to the "number + up/down" key combination.

In order to move the cursor up x lines, press the [ key, and treat the middle row of the Colemak keyboard layout ("arstdhneio") as number 1 to 0. Press the numbers that you'd like your cursor to move (x) and press the space bar.

To move the cursor down, press the ' key instead of the [ key, and the rest would be the same.

Example:

Note: As of now, you may only move vertically up to 199 lines with this key configuration!