ylib/nerdcommenter
ylib/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2025-02-27 12:00:11 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added help section about the Leader key (#385)

Browse Source
This commit is contained in:
Nagidal 2019-08-07 16:27:35 +02:00 committed by Caleb Maclennan
parent df2f6825f4
commit a05185584d
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/NERD_commenter.txt
View File

@ -11,6 +11,7 @@
CONTENTS *NERDCommenterContents*
1.Intro...................................|NERDCommenter|
1.1 Leader............................|NERDCommenterLeader|
2.Installation............................|NERDCommenterInstallation|
3.Functionality provided..................|NERDCommenterFunctionality|
3.1 Functionality Summary.............|NERDCommenterFunctionalitySummary|
@ -55,6 +56,20 @@ for most filetypes.
There are also options that allow to tweak the commenting engine to your
taste.
------------------------------------------------------------------------------
1.1 Leader key *NERDCommenterLeader*
Most NERD commenter commands are executed using the |<Leader>| key. In Vim
this is a key dedicated for user-specific customizations. It effectively
creates a namespace so that custom commands don't interfere with Vim's
built-in shortcuts.
The leader key can be mapped to whatever the user likes (see :help mapleader).
In the definition of custom commands |<Leader>| is the placeholder for the
leader key. To see the current mapping for |<Leader>| type :echo mapleader.
If it reports an undefined variable it means the leader key is set to the
default of '\'.
==============================================================================
2. Installation *NERDCommenterInstallation*