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

Shortcut	Action	Equivalent
u	Cursor up a terminal line	k
e	Cursor down a terminal line	j
n	Cursor left	h
i	Cursor right	l
U	Cursor up 5 terminal lines	5k
E	Cursor down 5 terminal lines	5j
N	Cursor to the start of the line	0
I	Cursor to the end of the line	$
Ctrlu	Move the view port up 5 lines without moving the cursor	Ctrly
Ctrle	Move the view port down 5 lines without moving the cursor	Ctrle
h	Move to the end of this word	e
W	Move cursor five words forward	5w
B	Move cursor five words forward	5b

1.3 Remapped Insert Mode Keys

Shortcut	Action
Ctrla	Move cursor to the end of the line
Ctrlu	Move the character on the right of the cursor to the end of the line

1.4 Remapped Text Manipulating Commands in Normal Mode

Shortcut	Action
l	undo
<	Un-indent
>	Indent
SPACESPACE	Goto the next placeholder (<++>)

1.5 Other Useful Normal Mode Remappings

Shortcut	Action
r	Compile/Run the current file
SPACEsc	Toggle spell suggestion a
SPACEdw	Find adjacent duplicated word
SPACEtt	Convert every 4 Spaces to a tab
SPACEo	Fold
SPACE-	Previous quick-fix position
SPACE+	Next quick-fix position
\p	Show the path of the current file
SPACE/	Create a new terminal below the current window

1.6 Remapped Commands in Visual Mode

Shortcut	Action
Y	Copy selected text to system clipboard

2 Window Management

2.1 Creating Window Through Split Screen

Shortcut	Action
su	Create a new horizontal split screen and place it above the current window
se	Create a new horizontal split screen and place it below the current window
sn	Create a new vertical split screen and place it left to the current window
si	Create a new vertical split screen and place it right to the current window
sv	Set the two splits to be vertical
sh	Set the two splits to be horizontal
srv	Rotate splits and arrange splits vertically
srh	Rotate splits and arrange splits horizontally

2.2 Moving the Cursor Between Different Windows

Shortcut	Action
SPACE + w	Move cursor to the next window
SPACE + n	Move cursor one window left
SPACE + i	Move cursor one window right
SPACE + u	Move cursor one window up
SPACE + e	Move cursor one window down

2.3 Resizing Different Windows

Use the arrow keys to resize the current window.

2.4 Closing Windows

Shortcut	Action
Q	Close the current window
SPACEq	Close the window below the current window. (The current window will be closed if there is no window below)

3 Tab Management

Shortcut	Action
tu	Create a new tab
tn	Go one tab left
ti	Go One tab right
tmn	Move tab left
tmi	Move tab right

4 Terminal Keyboard Shortcuts

Shortcut	Action
Ctrln	Escape from terminal input mode

Plugins Keybindings (Screenshots/GIF provided!)

AutoCompletion

COC (AutoCompletion)

Shortcut	Action
Spacey	Get yank history list
gd	Go to definition
gr	List references
gi	List implementation
gy	Go to type definition
Spacern	Rename a variable

coc-snippets

Shortcut	Action
Ctrle	Expand a snippet
Ctrln	(in snippet) Previous Cursor position in snippet
Ctrle	(in snippet) Next Cursor position in snippet

File Navigation

coc-explorer (file browser)

Shortcut	Action
tt	Open file browser
?	show help (in explorer)

rnvimr - file browser

• Make sure you have ranger installed

Press R to open Ranger (file selector)

And Within rnvimr (ranger), you can:

Shortcut	Action
Ctrlt	Open the file in a new tab
Ctrlx	Split up and down with the file
Ctrlv	Split left and right with the file

FZF - the fuzzy file finder

Shortcut	Action
Ctrlp	FZF Files
Ctrlu	Move up 1 item
Ctrle	Move down 1 item
Ctrlw	FZF Buffers
Ctrlf	FZF Files' Content
Ctrlh	FZF Recent Files
Ctrlt	FZF Tags

xtabline (the fancy tab line)

Shortcut	What it creates
to	Cycle tab mode
\p	Show current path

Text Editing Plugins

vim-table-mode

Shortcut	Action
SPACEtm	Toggle table mode
SPACEtr	Realign table

See :help table-mode.txt for more.

Undotree

Shortcut	Action
Shift + L	Open Undotree
u	Newer Version
e	Older Version

vim-visual-multi

Shortcut	Action
Ctrl+k	Select next key (multiple cursors)
q	Deselect the current keys (multiple cursors)
-	Select the previous key
=	Select the next key
Esc	Quit mutiple cursors

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 SPACEfr to search in cwd.

Git Related

vim-gitgutter

Shortcut	Action
H	Show git hunk at current line
SPACEg-	Go to previous git hunk
SPACEg+	Go to next git hunk
SPACEgf	Fold everything except hunks

fzf-gitignore

Press Spacegi to create a .gitignore file

Others

vim-calendar

Shortcut	Action
\\	Show clock
\c	Show calendar

Goyo - Work without distraction

Press gy 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

Shortcut	What it creates
,n	---
,b	Bold text
,s	sliced text
,i	italic text
,d	code block
,c	big block of code
,m	- [ ] check mark
,p	picture
,a	link
,1	# H1
,2	## H2
,3	### H3
,4	#### H4
,l	--------

,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:

Shortcut	Action
[aooSPACE	Move the cursor up 100 lines
'arsSPACE	Move the cursor down 123 lines
[doSPACE	Move the cursor up 50 lines

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