https://github.com/dahu/vim-help

Easier navigation within Vim help files
https://github.com/dahu/vim-help

Last synced: 3 months ago
JSON representation

Easier navigation within Vim help files

• Host: GitHub
• URL: https://github.com/dahu/vim-help
• Owner: dahu
• Created: 2014-05-16T06:02:46.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-14T21:55:06.000Z (over 8 years ago)
• Last Synced: 2024-06-18T09:36:40.479Z (5 months ago)
• Language: VimL
• Size: 8.79 KB
• Stars: 16
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.asciidoc

Awesome Lists containing this project

README

        
vim-help

--------

__Easier navigation within Vim help files__

TIP: If you like vim-help and want to share the W00t!, I'm grateful for

https://www.gittip.com/bairuidahu/[tips] or

http://of-vim-and-vigor.blogspot.com/[beverages].

vim-help provides several normal-mode maps to ease navigation within help files.

=== Normal Mode Maps Within Help Files

[caption="",cols="1     |Follow link under cursor (equivalent to ++ctrl-]++)

| |Jump back a tag (equivalent to ++ctrl-t++)

|j/k |Jump to next/prior quickfix entry (equivalent to +:cnext+ / +:cprev+)

|q   |Disable all vim-help maps (handy for editing vim help files)

|=============================================================================

=== Global Normal Mode Maps

[caption="",cols="1       | Cycles through terms from current line for :help

| | Jump back to prior help location.

|=============================================================================

NOTE: Jump to prior help location only works if you have

https://github.com/dahu/MarkMyWords[MarkMyWords] installed.

=== `:TopicToClipboard`

The `:TopicToClipboard` command sets the `@*` register with a `:help`

command to jump to the nearest help tag prior to the current cursor

position. If that help tag is more than 9 lines away, the help command

will include an offset to the current cursor line. If you want the

cursor line offset even though the help tag is less than 10 lines away,

use `:TopicToClipboard!` instead.