Nvim_Conf

Intro ℹ️

SuXYIO's Neovim config.

Screenshots 🎆

Screenshots

Dashboard, catppuccin colorscheme.

Lazygit, kanagawa colorscheme.

Code inspecting, duskfox colorscheme.

Telescope, everforest colorscheme.

Markdown preview, material colorscheme.

Note that these screenshots may not represent the actual effect, which is dependent on the terminal / NeoVim client config 💻.
Also, these screenshots might be outdated due to my laziness 😴.

Install 📲

Requirements 🔋

Basic

Install NeoVim (Which I assume you have done since you're browsing this repo 😅).
Install Nerdfont for your terminal or NeoVim client 💻.
Git is recommended for cloning the repo, but you can also use tools like wget or curl 🔧.

Simple ⭐

❗ Make sure you backup your current NeoVim config 💾.

git clone https://github.com/suxyio/Nvim_Conf ~/.config/nvim

Detailed 🌟

This will be a bit verbose

1. Optional
   Backup your current NeoVim config 💾.

mv ~/.config/nvim ~/.config/nvim.bak

1. Clone this repo 📡.

git clone https://github.com/suxyio/Nvim_Conf ~/.config/nvim

Check Install 🔍

You're done! 🎉
Startup NeoVim to check if it works.
If installed correctly, a grey Lazy window will show up to clone the plugins.

nvim

If any help is needed, feel free to report it in Issues 😉.

Enjoy! 😊

Features 📊

Plugin 🔌

Manager: Lazy.nvim 💤

Plugin list

Plugin	Description	Idle (You have to toggle manually)
Autopairs	Better insert experience for paired characters	N
Bufferline	Provide bufferline	N
Cmp	Provide completion	N
Codeium	Provide AI assist	N
Gitsigns	Well, gitsigns, literally	N
LspSaga	Better LSP experience	N
Lualine	Provide fancy lines and tabs	N
Mason	Install LSPs	N
MarkdownPreview	Preview markdown files	N
Neotree	Provide tree view	Y
Notify	Notice UI	N
NvimTree	Provide tree view	N
Snacks	Provide useful stuff	N
Telescope	Find files	N
TodoComments	Highlight todo comments	Y
Transparent	Transparent background	N
Wilder	Provide cmdline completion	N
ZenMode	Provide zen mode	Y

LSP 📕

Manager: Mason.nvim

The autoload feature in Mason is enabled, just install the LSPs needed, no need to config every single one ☺️.

Keymap 🎹

Keymap list

Note: The single characters here are all capital, which represents the key on the keyboard, capital key presses will be represented with Shift.

Base ⭐

Mode	Key	Map	Description
/	;	leader	Leader key
N	Cmd-C	"+y	Copy to system clipboard
N	Cmd-V	"+P	Paste from system clipboard in normal mode
I	Cmd-V	<Esc>"+P	Paste from system clipboard in insert mode
N	Leader-Q	<CMD>q<CR>	Quit
N	Leader-WW	<CMD>w<CR>	Save
N	Leader-WA	<CMD>wa<CR>	Save all
N	Leader-WQ	<CMD>wq<CR>	Save & Quit
I	JK	<Esc>	Escape from insert mode
N	Space	:	Go to command mode
N	Ctrl-K	ddkP	Move line up
N	Ctrl-J	ddp	Move line down
N	Esc	<CMD>noh<CR>	Remove highlight (clear search highlight)
N	Leader-J	<CMD>bn<CR>	Switch next buffer
N	Leader-H	<CMD>bp<CR>	Switch previous buffer
N	Leader-W	<C-w>	Window control
N	ZL	<CMD>vs<CR>	Toggle vertical split
N	ZJ	<CMD>sp<CR>	Toggle split
N	Leader-L	<CMD>terminal<CR>	Open terminal
T	LeaderEsc	<C-\\><C-n>	Escape from terminal mode

Plugin 🔌

Plugin	Mode	Key	Map	Description
LspSaga	N	]E	<CMD>Lspsaga diagnostic_jump_next<CR>	Jump to next diagnostic
LspSaga	N	[E	<CMD>Lspsaga diagnostic_jump_prev<CR>	Jump to previous diagnostic
LspSaga	N	Leader-A	<CMD>Lspsaga code_action<CR>	Show actions of code
LspSaga	N	Leader-S	<CMD>Lspsaga outline<CR>	Show outline(structure) of code
LspSaga	N	Z-D	<CMD>Lspsaga peek_definition<CR>	Peek definition
MarkdownPreview	N	Z-M	<CMD>MarkdownPreviewToggle<CR>	Toggle markdown preview
NvimCmp	I	Enter	cmp.mapping.confirm({select = true})	Confirm completion
NvimCmp	I	Esc	cmp.mapping.abort()	Abort completion
NvimTree	N	Leader-F	<CMD>NeoTree<CR>	Toggle tree view
Snacks	N	Leader-D	Snacks.lazygit()	Toggle LazyGit
Snacks	N	Leader-K	Snacks.bufdelete()	Delete buffer
Telescope	N	FF	<CMD>Telescope<CR>	Telescope
Transparent	N	Shift-T	<CMD>TransparentToggle<CR>	Transparent toggle

Colorscheme 🌈

Colorscheme
Catppuccin
EverForest
Kanagawa
Material
NightFox

theme change 🚥

The colorscheme, background, lineseps can be different on every startup over a certain rule.
(random, time, random is default)

Font 📖

Nerdfont is needed to show properly.

Misc ✨

Self-defined commands 🔖

Self-defined command list

Command	Description
Hex	Convert buffer raw to hex code. Convert back using Hex!. You can also add args directly, for example Hex -p will pass the -p to xxd. Requires xxd installed.

Grammar check 🔤

Uses the built-in SpellCheck.

Client support 💻

The client Neovide is supported, see lua/client.lua.

Todo

• Reduce startup time
• Add system status in lualine