From 5f6faa1bf0da69baa1f1f523ba2108a8fb9e9272 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 8 Jun 2020 14:49:59 +0530 Subject: [PATCH] Make a central list of integrations in the docs Fixes #2750 --- docs/index.rst | 9 +++++ docs/integrations.rst | 93 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+) create mode 100644 docs/integrations.rst diff --git a/docs/index.rst b/docs/index.rst index 4712dc00e..7a1f50dba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -439,6 +439,15 @@ The list of Frequently Asked Questions (*FAQ*) is :doc:`available here `. .. _completion: + +Cool integrations for kitty with other CLI tools +-------------------------------------------------- + +kitty provides extremely powerful interfaces such as :doc:`remote-control` and +:doc:`kittens/custom` and :doc:`kittens/icat` +that allow it to be integrated with other tools seamlessly. For a list of such +user created integrations, see: :doc:`integrations`. + Completion for kitty --------------------------------- diff --git a/docs/integrations.rst b/docs/integrations.rst new file mode 100644 index 000000000..14ecb6139 --- /dev/null +++ b/docs/integrations.rst @@ -0,0 +1,93 @@ +Integrations with other tools +================================ + +kitty provides extremely powerful interfaces such as :doc:`remote-control` and +:doc:`kittens/custom` and :doc:`kittens/icat` +that allow it to be integrated with other tools seamlessly. + + +Image and document viewers +---------------------------- + +Powered by kitty's :doc:`graphics-protocol` there exist many tools for viewing +images and other types of documents directly in your terminal, even over SSH. + +`termpdf.py `_ + a terminal PDF/DJVU/CBR viewer + +`ranger `_ + a terminal file manager, with previews of file contents powered by kitty's graphics protocol. + +`nnn `_ + another terminal file manager, with previews of file contents powered by kitty's graphics protocol. + + +System and data visualisation tools +--------------------------------------- + +`neofetch `_ + A command line system information tool that shows images using kitty's graphics protocol + +`gnuplot `_ + a graphing and data visualization tool that can be made to display its + output in kitty with the following bash snippet:: + + function iplot { + cat <`_ + integrates with kitty to use native kitty windows for its windows/panels and REPLs. + +`vim-slime `_ + uses kitty remote control for a Lisp REPL. + +`vim-kitty-navigator `_ + allows you to navigate seamlessly between vim and kitty splits using a consistent set of hotkeys. + + +Scrollback manipulation +------------------------- + +`kitty-search `_ + Live incremental search of the scrollback buffer. + +`kitty-grab `_ + keyboard based text selection for the kitty scrollback buffer. + + + +Miscellaneous +------------------ + +`kitty-smart-tab `_ + use keys to either control tabs or pass them onto running applications if + no tabs are present + +`kitty-smart-scroll `_ + use keys to either scroll or pass them onto running applications if + no scrollback buffer is present + +`reload keybindings `_ + reload key bindings from :file:`kitty.conf` without needing to restart + kitty