Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bytesnake/vim-graphical-preview

Small plugin for Vim to display graphics with SIXEL characters
https://github.com/bytesnake/vim-graphical-preview

Last synced: 17 days ago
JSON representation

Small plugin for Vim to display graphics with SIXEL characters

Awesome Lists containing this project

README 

        
# Display graphics in (N)Vim with SIXEL characters



Adds the ability to display graphics to (N)Vim. This is developed for my digital notebook and is still in infancy. Expect weird behaviour and crashes.



The picture's content is streamed via the SIXEL character set (see [1](https://saitoha.github.io/libsixel/), [2](https://en.wikipedia.org/wiki/Sixel), [3](https://www.vt100.net/docs/vt3xx-gp/chapter14.html) for more information) 



## Features



 - [x] Render LaTex equations within math fences

 - [x] Display pictures in standalone image links

 - [x] Support GnuPlot, arbitrary LaTex, fetch source from other files

 - [ ] Fix weird artifacts of SIXEL



## Examples



### Graphic and LaTex math support



https://user-images.githubusercontent.com/989353/187507544-9cbebd36-5a53-43eb-898a-5f64200d8b68.mp4



### Support folding



https://user-images.githubusercontent.com/989353/187507582-f4daee70-ead3-4aba-a256-4d4c72223bbd.mp4



### Stream SIXEL characters via any text medium



https://user-images.githubusercontent.com/989353/187510494-0416f52a-6b69-4e36-a901-d58aa0747d63.mp4



## Installation



The installation is a bit more involved. You have to make sure that your terminal is able to render SIXEL characters. The plugin is written in Rust for performance reasons, and interfaced to Vimscript with [libcallex-vim](https://github.com/mattn/libcallex-vim). For this you also need to install toolchains for Rust and C. Imagemagick is also required to convert between different graphic formats and SIXEL.



First use a terminal supporting SIXEL characters



 * Tested: Alacritty ([PR #4763](https://github.com/alacritty/alacritty/pull/4763) or merged in this [fork](https://github.com/microo8/alacritty-sixel)) 

 * Not tested: XTerm, [others](https://saitoha.github.io/libsixel/)



You have to install imagemagick to render graphics to SIXEL format:



 * Archlinux: `pacman -S imagemagick`

 * Ubuntu: package `libmagickwand` too old, see `https://github.com/SoftCreatR/imei`

 * Other: https://imagemagick.org/script/download.php



Before installing the vim plugin, make sure that toolchains for Rust and C are installed:



 * for C install `make` and `gcc`

 * for Rust install a stable toolchain, for example with [rustup](https://rustup.rs/)



Finally add the following section to your vim configuration

```

Plug 'mattn/libcallex-vim', { 'do': 'make -C autoload' }

Plug 'bytesnake/vim-graphical-preview', { 'do': 'cargo build --release' }

```



and install with `source %|PlugInstall`.



The plugin is currently not mapped to a file format, but can be manually enabled by setting the `filetype` variable to `graphical-preview` or add the follow preamble to your file:



```vim

vim: set filetype=markdown.graphics :

```



## FAQ



 > The graphic is overlapping with the command and status line



This is a limitation of SIXEL as it always scrolls after a line and would do that as well for the last one. Otherwise we could overlap and delete with a raster sequence. There is special mode, disabling this behaviour, but then your image is fixed at the upper, left corner (see [here](https://gitlab.com/AutumnMeowMeow/jexer/-/issues/61)).



 > TODO



## Kudos to



 - [heapslip](https://github.com/heapslip) for inspiring me with [vimimage](https://www.youtube.com/watch?v=cnt9mPOjrLg)

 - the awesome people at alacritty, [Ayose Cazorla](https://github.com/alacritty/alacritty/pull/4763) and [microo8](https://github.com/microo8/alacritty-sixel)