dccsillag / magma-nvim

Interact with Jupyter from NeoVim.
GNU General Public License v3.0
977 stars 49 forks source link

Render images with `image.nvim` #115

Closed benlubas closed 10 months ago

benlubas commented 11 months ago

this will stay in draft state until todo items are done

The What

image.nvim is a NeoVim plugin that adds image support. This PR uses the plugin like a library to render image outputs.

This PR also incorporates some performance improvements that were proposed in #43, with a few bugs ironed out.

The Why

  1. Consistency. Before, we had our own image implementations. There was a kitty graphics image implementation, and an uberzug image implementation. I never used uberzug, but the kitty implementation was inconsistent at best, and buggy at worst for me. I've found image.nvim's implementation to be very solid, and the maintainer very interested in fixing bugs that I've brought up.

  2. Maintainability. Handling our own image rendering is far less maintainable than simply outsourcing the heavy lifting to another plugin.

  3. Image.nvim has sixel support on the road map. I'm not sure if/when that'll be, but we'll get it for free if it even happens.

Considerations

todo

benlubas commented 10 months ago

I think I'm just going to close this PR out, and maintain a fork of this plugin under a different name.

I don't want to bother others with an excessive number of PRs, and I'd like to make many large and some breaking changes to improve the plugin. I think it's best to just work in my own repo.