eraserhd / kak-ansi

Kakoune support for rendering ANSI-colored text.
https://github.com/eraserhd/kak-ansi
The Unlicense
39 stars 4 forks source link
kakoune plugin

kak-ansi

Kakoune support for rendering ANSI-colored text.

== Installing

You'll need a C99-compatible C compiler. The Kakoune plugin will build the filter program automatically if it's not already built on load. If you want to build it manually instead:

[source,sh]

$ make

== Usage

This plugin provides ansi-render, ansi-render-selection, ansi-clear, ansi-enable and ansi-disable commands. In addition, when Kakoune is used as a pager, it will automatically execute ansi-enable in the *stdin* buffer to process escape codes when idle.

ansi-render:: Removes ANSI escapes from the buffer and adds highlighting for regions that were ANSI-colored. ansi-render-selection:: Removes ANSI escapes from selections and adds highlighting for regions that were ANSI-colored. ansi-clear:: Clear highlighting added by the previous two commands. ansi-enable:: Configures current buffer to run ansi-render on the new data received through fifo. ansi-disable:: Disables automatic rendering of new fifo data.

== Contributing

New features and bug fixes should have test coverage in tests/tests.bash where possible. Tests can be run with a modern bash:


$ bash tests/tests.bash