Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smolck/uivonim
Fork of the Veonim Neovim GUI
https://github.com/smolck/uivonim
electron gui neovim neovim-guis typescript webgl2
Last synced: 30 days ago
JSON representation
Fork of the Veonim Neovim GUI
- Host: GitHub
- URL: https://github.com/smolck/uivonim
- Owner: smolck
- License: agpl-3.0
- Created: 2020-10-01T01:24:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T14:21:22.000Z (11 months ago)
- Last Synced: 2024-09-25T07:32:07.739Z (about 2 months ago)
- Topics: electron, gui, neovim, neovim-guis, typescript, webgl2
- Language: TypeScript
- Homepage:
- Size: 8.76 MB
- Stars: 616
- Watchers: 10
- Forks: 12
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
  [](https://gitter.im/uivonim/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
> NOTE: Due to [neovim/neovim#13196](https://github.com/neovim/neovim/issues/13196), if you have `conceallevel` set to a value higher than 0 CPU usage may be abnormally high. See [#39 (comment)](https://github.com/smolck/uivonim/issues/39#issuecomment-719816263).
Uivonim is a fork of Veonim,
"a simple modal IDE built on Neovim and VSCode extensions" written in Electron with WebGL GPU
rendering and multithreading. The goal of
Uivonim is to use Veonim as a base for building a feature-rich cross-platform GUI
that leverages the latest Neovim features (floating windows, builtin LSP, Lua)
without reliance on VSCode extensions.
## Goals
- 100% compatibility with Neovim (see [#9421](https://github.com/neovim/neovim/issues/9421))
- All configuration done via vimrc with vimscript/Lua/remote plugins
- GUI features and eyecandy
- Full support for international keyboard layouts and dead keys (tested on macOS and Linux)
- Fast, building upon the work done by @breja, with things like WebGL GPU
rendering and multithreading
- Extensibility via a Lua API providing access to frontend GUI features such as
[LSP hover/signature help/symbols](https://github.com/smolck/uivonim/wiki/Builtin-LSP) and a fuzzy finder UI
## Getting Started
Download the latest GitHub release, or build from source (see the "build" section at the bottom of this README). Alternatively,
if you use Arch Linux, there is an [AUR package](https://aur.archlinux.org/packages/uivonim-git/) for uivonim, kindly created
by [@SilverRainZ](https://github.com/SilverRainZ) (see [#55](https://github.com/smolck/uivonim/issues/55)).
## Build
Install the following things:
- node/npm
- latest Neovim (i.e., nightly or built from master)
Then run:
- `npm ci` - standard issue download 5 million node_modules
- `npm run prod` (optional) - run release build w/out packaging
- `npm run package` - use electron-builder to create a binary package
Binaries available in `dist`.
### Development
- `npm ci` - install deps as mentioned above
- `npm run dev` - run dev build
If you have any questions about Uivonim's code, making a change, etc., feel free to ping me (@smolck)
[on Gitter](https://gitter.im/uivonim/community).
## Feature Showcase
See [the wiki](https://github.com/smolck/uivonim/wiki/Builtin-LSP) for setup for
the signature help, float, etc. features.
### Signature Help
### Hover
### Code Actions
### References
### Nyancat
`:Uivonim nc`
## Other Cool Projects
- [Neovide](https://github.com/Kethku/neovide)
- [GoNeovim](https://github.com/akiyosi/goneovim)
- [GNvim](https://github.com/vhakulinen/gnvim)
## Special Thanks
An absolutely massive thank you to @breja for all
of the work you did on the original Veonim project; without your work
(including the amazing achievement of making Electron snappy!) and vision
for the original project, Uivonim would not exist. Thank you!