Neovim Configuration Wiki

This wiki documents this Kickstart Modular Neovim configuration: what is installed, which keybinds matter, how to find your way around Neovim, and where to change things when the setup should grow with you.

Quick Start

This is a Kickstart-based config, so it is intentionally readable and hackable. The important entry points are:

init.lua: sets the leader key, Nerd Font flag, and loads the rest of the config.
lua/options.lua: editor behavior such as line numbers, clipboard, search, splits, whitespace, and undo.
lua/keymaps.lua: global keymaps and diagnostic defaults.
lua/lazy-bootstrap.lua: installs lazy.nvim if it is missing.
lua/lazy-plugins.lua: registers plugins with lazy.nvim.
lua/kickstart/plugins/*.lua: one plugin or feature group per file.
lua/custom/plugins/init.lua: safe place for personal plugin additions.

The leader key is <space>. Any mapping that starts with <leader> starts by pressing the space bar.

Wiki Pages

Basic Neovim: modes, buffers, windows, tabs, help, and common commands.
Keybinds: important custom keymaps from this config.
Plugins: plugin list and what each plugin does.
Customization: where to add options, plugins, formatters, LSPs, and themes.
Troubleshooting: health checks, plugin updates, Mason, Treesitter, and common fixes.

Daily Workflow

Start with these commands and mappings:

:Tutor: built-in interactive Neovim tutorial.
<space>sh: search Neovim help with Telescope.
<space>sf: find files.
<space>sg: search text in the current project.
<space><space>: switch between open buffers.
<space>sn: search files inside this Neovim config.
<space>f: format the current buffer.
<space>q: open diagnostics in the location list.
:Lazy: inspect, install, update, and manage plugins.
:Mason: inspect installed LSP servers and external tools.
:checkhealth: diagnose missing tools or environment problems.

What This Config Gives You

Plugin management through lazy.nvim.
Fuzzy finding through Telescope.
LSP support through nvim-lspconfig, Mason, and Mason tool installer.
Completion through blink.cmp and snippets through LuaSnip.
Formatting through conform.nvim.
Git gutter signs and hunk actions through Gitsigns.
Syntax highlighting and indentation support through Treesitter.
Keymap discovery through Which Key.
Text objects, surround editing, and a statusline through mini.nvim.
TODO comment highlighting through todo-comments.nvim.
A Tokyonight colorscheme.

First Things To Learn

Neovim is easiest when these ideas click:

Normal mode is for moving and issuing commands.
Insert mode is for typing text.
Visual mode is for selecting text.
Command-line mode starts with : and runs commands like :write or :Lazy.
Buffers are open files.
Windows are views into buffers.
Tabs are layouts of windows, not browser-style file tabs.
The built-in help is excellent. Use :help topic or <space>sh.

If something feels mysterious, search help first. For example:

:help vim.keymap.set
:help options
:help lsp
:help diagnostic
:help user-manual