oknozor / illumination Goto Github PK

A mardown renderer for nvim written with gtkrs and neovim-lib

License: GNU General Public License v3.0

Vim Script 5.29% Rust 91.01% Shell 3.69%

neovim gtk gtk-rs webkit2gtk markdown rust neovim-plugin neovim-guis

illumination's Introduction

Nvim Illumination : A lightweight GTK live preview for your notes

An illuminated manuscript is a manuscript in which the text is supplemented with such decoration as initials, borders (marginalia) and miniature illustrations. In the strictest definition, the term refers only to manuscripts decorated with either gold or silver; but in both common usage and modern scholarship, the term refers to any decorated or illustrated manuscript from Western traditions.

From Wikipedia, the free encyclopedia

Nvim Illumination is a simple Neovim plugin to render buffers in a WebKit2Gtk window. Since it uses the Neovim rpc-api to send buffer updates, ⚠️ it will not work with vim ⚠️.

Note that unlike many note rendering plugins Illumination does not render files, it renders your buffer directly via nvim rpc api, it means you don't need to save the current buffer to render your notes, it is really live!

Issues and PRs are welcome!

Intallation

Manual installation

git clone  https://github.com/oknozor/illumination/
cd illumination
./install

Using vim-plug

Requirement

vim-plug obviously
Rust with cargo as a package manager
You need to have $HOME/.cargo/bin/ in your $PATH : you can add the following line in your bashrs, zshrc or /etc/profile : export PATH="$HOME/.cargo/bin:$PATH"

Plug 'oknozor/illumination', { 'dir': '~/.illumination', 'do': '.install.sh' }

Usage

Command	Description
:Illuminate	Start rendering the current buffer
:IlluminateClose	Close Illumination
:IlluminateLock	Toggle lock (won't change active buffer)
:IlluminateOpen	Render a local file or an URL and toogle lock

Debug

To debug Illumination start nvim in RPC mode on port 6666 :

nvim test.md --listen 127.0.0.1:6666

Then run Illumination without cargo --release option.

cd illumination
cargo run

illumination's People

Contributors

Stargazers

Watchers

Forkers

cmattssonjr snakedye cosmoduff dauliac jpx40

illumination's Issues

Add standalone mod

By default Illumination should start in non nvim RPC mod.

Fix auto scrolling range

Does not scroll to maximum top position when scrolling from bottom to top

nvimMd: rpc process is not executable

Deployment via vim-plug seems to work, the path directories are created and the content is inside.
However, with both a new file and a previously saved file, each time I run :Illuminate this error happens:

Error detected while processing function <SNR>9_render:
line    5:
nvimMd: rpc process is not executable

➜  .illumination git:(master) ✗ cargo build     
   Compiling illumination v0.2.0 (/home/esilva/.illumination)
error[E0277]: the trait bound `gio::auto::cancellable::Cancellable: glib::object::IsA<gio::auto::cancellable::Cancellable>` is not satisfied
   --> src/ui/app.rs:121:39
    |
121 |     webview.run_javascript(js_scroll, None::<&gio::Cancellable>, move |msg| {
    |                                       ^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `glib::object::IsA<gio::auto::cancellable::Cancellable>` is not implemented for `gio::auto::cancellable::Cancellable`

error[E0277]: the trait bound `webkit2gtk::auto::web_view::WebView: glib::object::IsA<gtk::Widget>` is not satisfied
  --> src/ui/content.rs:16:25
   |
16 |         container.pack1(&preview, true, true);
   |                         ^^^^^^^^ the trait `glib::object::IsA<gtk::Widget>` is not implemented for `webkit2gtk::auto::web_view::WebView`

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0277`.
error: could not compile `illumination`.

To learn more, run the command again with --verbose.

The rust version is 1.40.0.

Thanks, nice project!

add a side panel with displaying user defined notes directory (via toml config file).
add rpc message to open file in neovim on click.