Skip to content
Ease browsing of kakoune documentation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
rc
LICENSE
README.md

README.md

search-doc.kak

License

search-doc.kak is a Kakoune plugin that provides a command for opening the kakoune documentation for a specific item. The command, :search-doc, is an alternative to the built in command :doc and it comes with the advantages that

  • it jumps to a much more detailed location, and

  • it shows completion options in a more informative way.

screenshot

Installation

With plug.kak

You can install search-doc.kak using the plug.kak plugin manager by extending your kakrc with:

plug "jbomanson/search-doc.kak" config %{
    require-module search-doc
}

Then restart Kakoune and run :plug-install.

Manually

In your kakrc, include:

source "/path/to/search-doc.kak/rc/search-doc.kak"
require-module search-doc

Usage

Use the :search-doc <topic> function when intending to browse kakoune documentation, and enjoy the autocompletion!

You can’t perform that action at this time.