Skip to content

The help page

In Vim and Neovim the official documentation actually lives inside the editor itself. We call this the "help page."

If you are interested in reading the documentation using your browser:

The :help command

:help is the mechanism we use to navigate the documentation inside the editor.

If we provide an argument to the :help command it will show a specific part of the documentation. For example, we can learn about the syntax of the command with this:

vim
:help help-summary

:help is good when we have an idea of the thing we looking for. When we already know the right words and terms. I say this because :help will search for "help tags." If the term we provide is not part of a help tag the command will fail.

If we only have a vague clue of the thing we are looking the :helpgrep command is a better option. This will search the content of the help pages instead of just help tags. Here's an example.

vim
:helpgrep thesaurus

The results of the search will be stored in a quickfix list and the cursor will move to the first match.

We can inspect the quickfix list using this command.

vim
:copen

Once inside the quickfix window press Enter in any item to move to that location.

The user manual

The user manual is a book, a practical guide on how to use Vim. Yes, Vim. But don't worry because 99% of it still applies to Neovim.

This book has 40+ chapters so I don't expect anyone to read all of it. So here are the chapters I think will be useful to someone that's just starting to learn about Vim.

CommandDescription
:help usr_tocTable of content
:help usr_02The first steps in Vim
:help usr_03Moving around
:help usr_04Making small changes
:help usr_20Typing command-line commands quickly
:help usr_22Finding the file to edit
:help usr_24Inserting quickly

The reference manual

This is the part of the documentation that explains every feature available in the editor.

Note the reference manual in the Neovim's online documentation is generated from the master branch of the github repository. Keep this in mind if you want to learn about avanced features of the lua API, it can be different across Neovim versions.

CommandDescription
:help reference_tocList of help files
:help startingStarting Vim, Vim command arguments, initialisation
:help cursor-motionsCommands for moving around
:help windowsCommands for using windows and buffers
:help map.txtKey mapping and user-defined commands
:help autocmdAutomatic commands
:help lua-guideNvim lua guide
:help option-listOverview of all options
:help Ex-commandsList of all the ":" commands
:help vimscript-functionsVimscript functions
:help luaLua API
:help vimscriptVimscript reference