https://github.com/oknozor/illumination

A mardown renderer for nvim written with gtkrs and neovim-lib
https://github.com/oknozor/illumination

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

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/oknozor/illumination
• Owner: oknozor
• License: gpl-3.0
• Created: 2019-03-27T17:21:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T11:10:34.000Z (4 months ago)
• Last Synced: 2024-06-10T00:37:13.588Z (3 months ago)
• Topics: gtk, gtk-rs, markdown, neovim, neovim-guis, neovim-plugin, rust, webkit2gtk
• Language: Rust
• Size: 641 KB
• Stars: 83
• Watchers: 4
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://neovim.io/doc/user/api.html), it means you don't need to save the current buffer to render your notes, it is really live!  

Issues and PRs are welcome! 

![example screenshot](screenshots/demo.png)

## Intallation

### Manual installation

---

```sh

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

cd illumination

./install

```

### Using vim-plug

#### Requirement 

- [vim-plug](https://github.com/junegunn/vim-plug) obviously

- [Rust](https://www.rust-lang.org/) 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"`

```vim

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 

```