Nulo/fzf.kak
1
0
Fork 0
Code Releases Activity

add note about Preview

Browse source
This commit is contained in:
Andrey Orst 2018-10-11 08:18:06 +03:00
parent bee6887a32
commit 4b4d783341
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -16,7 +16,6 @@
|GNU Screen|GNU Screen is not yet supported. | |GNU Screen|GNU Screen is not yet supported. |
## Installation ## Installation
Recommended way to install is to use [plug.kak](https://github.com/andreyorst/plug.kak) plugin Recommended way to install is to use [plug.kak](https://github.com/andreyorst/plug.kak) plugin
manager. You can install **fzf.kak** by adding this to your `kakrc`: manager. You can install **fzf.kak** by adding this to your `kakrc`:
@ -29,7 +28,6 @@ Then reload Kakoune config or restart Kakoune and run `:plug-install`.
Or install this plugin any other preferred way. Or install this plugin any other preferred way.
## Usage ## Usage
**fzf.kak** doesn't provide any mapping by default. Instead there's now a `fzf-mode` command **fzf.kak** doesn't provide any mapping by default. Instead there's now a `fzf-mode` command
which intentionally was made to simplify user mappings. which intentionally was made to simplify user mappings.
Each fzf command has mnemonic mapping, like `f` for opening files, `t` for tags and so on. Each fzf command has mnemonic mapping, like `f` for opening files, `t` for tags and so on.
@ -85,6 +83,20 @@ It is also possible to add parameters to ctags search executable:
set-option global fzf_tag_command 'readtags -l | cut -f1 | sort -u | ... ' set-option global fzf_tag_command 'readtags -l | cut -f1 | sort -u | ... '
``` ```
#### Preview
You can turn on the preview window in fzf window by setting `fzf_preview` option to `true`:
```kak
set-option global fzf_preview true
```
You also can specify which highlighter to use within the preview window with `fzf_highlighter` option.
Supported tools are:
* Rouge
* Highlight
* Coderay
## Some demonstration gifs: ## Some demonstration gifs:
### Opening files: ### Opening files:
![files](https://user-images.githubusercontent.com/19470159/45917778-3988e200-be85-11e8-890d-b180d013b99e.gif) ![files](https://user-images.githubusercontent.com/19470159/45917778-3988e200-be85-11e8-890d-b180d013b99e.gif)