Before we start, lets discuss the conventions used in the following discussions.

First, while most functions and commands are interchangeable between Vim and Neovim, the differences are slowly increasing. While we may use Vim and Neovim interchangeably, our intent is to specifically refer to Neovim behaviors, unless the context makes it clear we are specifically referring to Vim. This is not intended as a slight towards Vim or the Vim community, there is a ton of Vim-specific content available on the web, and we mean this only to clarify our goals for this part of the project.

Next, we generally follow notation similar to that used in the Neovim help files, except in some cases where a web-based format offers improved user-experience over the text format used in Neovim's documentation:

Brackets [ ]

Brackets indicate optional components of commands Note that sometimes literal brackets are included in a command. These cases should be clear from the context.

Curly Braces { }

Curly braces indicate parts of a command that must appear, but can take a number of different values.

The content inside the curly braces can take several forms:

Literal Inputs

Literal inputs are often shown in literal "code blocks", such as

nvim {filename}

to indicate that they represent text that should be typed literally. As shown in this example, brackets and/or curly-braces may be used to indicate optional or variable input.

Code Blocks

Code blocks have a "click to clipboard" function, allowing their content to be easily copied to the clipboard and pasted into Neovim.

Code blocks that represent command-line commands are copied without the leading ":" so that the can be easily pasted into your command line using C-R then hitting *.