Skip to content

Yet another plugin to open the official doc from help in Neovim

Notifications You must be signed in to change notification settings

delphinus/open-official-doc.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

open-official-doc.nvim

Yet another plugin to open the official doc from help in Neovim.

What's this?

With this plugin, you can open pages in Documentation - Neovim when you are reading helps in Neovim.

I've borrowed this idea from an article: NeovimのヘルプからNeovim docsを参照する. I found some cases not to work with this script, so fixed them and made up to this plugin.

How to use

Launch the command: :OpenOfficialDoc in reading help. Or, you can supply name (and tag) to open pages directly.

" search the helptag around your cursor and open it.
:OpenOfficialDoc
" open the page
:OpenOfficialDoc change
" open the helptag on the page
:OpenOfficialDoc change <<

The last example opens https://neovim.io/doc/user/change.html#%3C%3C, that means the << mapping in change.txt.

For vimdoc-ja

In addition to the original script, you can open the official doc from help pages translated to Japanese: vim-jp/vimdoc-ja.

The current build only supports vimdoc-ja installed by lazy.nvim.

TODO

  • Support Neovim HEAD installed by Homebrew
  • Open tags including special characters
  • Open tags in index.txt
  • Open * (star)
  • Specify the directory containing vimdoc-ja
  • Add additional directories containing help
  • Open vimdoc-ja instead of Neovim doc

About

Yet another plugin to open the official doc from help in Neovim

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages