From 4b4d78334149955db415cdd29b60bbe489eb3c6a Mon Sep 17 00:00:00 2001 From: Andrey Orst Date: Thu, 11 Oct 2018 08:18:06 +0300 Subject: [PATCH] add note about Preview --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c4e142..aa653c2 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ |GNU Screen|GNU Screen is not yet supported. | ## Installation - 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`: @@ -29,7 +28,6 @@ Then reload Kakoune config or restart Kakoune and run `:plug-install`. Or install this plugin any other preferred way. ## Usage - **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. 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 | ... ' ``` +#### 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: ### Opening files: ![files](https://user-images.githubusercontent.com/19470159/45917778-3988e200-be85-11e8-890d-b180d013b99e.gif)