{"id":13897610,"url":"https://github.com/oknozor/illumination","last_synced_at":"2025-06-11T15:07:28.265Z","repository":{"id":65711682,"uuid":"178042270","full_name":"oknozor/illumination","owner":"oknozor","description":"A mardown renderer for nvim written with gtkrs and neovim-lib","archived":false,"fork":false,"pushed_at":"2024-05-16T11:10:34.000Z","size":656,"stargazers_count":85,"open_issues_count":9,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-02T00:24:20.993Z","etag":null,"topics":["gtk","gtk-rs","markdown","neovim","neovim-guis","neovim-plugin","rust","webkit2gtk"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oknozor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-27T17:21:11.000Z","updated_at":"2024-11-07T10:48:13.000Z","dependencies_parsed_at":"2024-10-11T23:01:04.871Z","dependency_job_id":"201a68e9-5eb5-4d32-8264-8f981dbab65c","html_url":"https://github.com/oknozor/illumination","commit_stats":{"total_commits":44,"total_committers":2,"mean_commits":22.0,"dds":"0.022727272727272707","last_synced_commit":"1f0c985eebab930126809e1aa3c9a8992daee3e8"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Fillumination","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Fillumination/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Fillumination/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oknozor%2Fillumination/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oknozor","download_url":"https://codeload.github.com/oknozor/illumination/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238795455,"owners_count":19531746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gtk","gtk-rs","markdown","neovim","neovim-guis","neovim-plugin","rust","webkit2gtk"],"created_at":"2024-08-06T18:03:44.691Z","updated_at":"2025-02-14T06:31:48.505Z","avatar_url":"https://github.com/oknozor.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Nvim Illumination : A lightweight GTK live preview for your notes\n\n\n---\n\u003e 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.\n\nFrom Wikipedia, the free encyclopedia\n\n--- \nNvim 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** ⚠️. \n\nNote 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!  \n\nIssues and PRs are welcome! \n\n![example screenshot](screenshots/demo.png)\n\n## Intallation\n\n### Manual installation\n---\n\n```sh\ngit clone  https://github.com/oknozor/illumination/\ncd illumination\n./install\n```\n\n### Using vim-plug\n\n#### Requirement \n\n- [vim-plug](https://github.com/junegunn/vim-plug) obviously\n- [Rust](https://www.rust-lang.org/) with cargo as a package manager\n- You need to have `$HOME/.cargo/bin/` in your `$PATH` :\n  you can add the following line in your bashrs, zshrc or /etc/profile : `export PATH=\"$HOME/.cargo/bin:$PATH\"`\n\n```vim\nPlug 'oknozor/illumination', { 'dir': '~/.illumination', 'do': '.install.sh' }\n```\n\n## Usage\n\n| Command          | Description                                   |\n| ---------------- |:---------------------------------------------:|\n| :Illuminate      | Start rendering the current buffer            |\n| :IlluminateClose | Close Illumination                            |\n| :IlluminateLock  | Toggle lock (won't change active buffer)      |\n| :IlluminateOpen  | Render a local file or an URL and toogle lock |\n\n## Debug\n\nTo debug Illumination start nvim in RPC mode on port `6666` :\n\n```\nnvim test.md --listen 127.0.0.1:6666\n```\n\nThen run Illumination without cargo `--release` option. \n\n```\ncd illumination\ncargo run \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foknozor%2Fillumination","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foknozor%2Fillumination","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foknozor%2Fillumination/lists"}