oni on GitHub (onivim/oni) — FAQ & Similar Projects · GitHub.Locker

oni README

The project's README from github.com/onivim/oni. As one markdown file: README.md.

NOTE: This repository is unmaintained - we are focusing on Onivim 2 and libvim.

Logo

Modern Modal Editing

Introduction

Oni is a new kind of editor, focused on maximizing productivity - combining modal editing with features you expect in modern editors. Oni is built with neovim, and inspired by VSCode, Atom, LightTable, and Emacs

The vision of Oni is to build an editor that allows you to go from thought to code as easily as possible - bringing together the raw editing power of Vim, the feature capabilities of Atom/VSCode, and a powerful and intuitive extensibility model - wrapped up in a beautiful package.

Check out Releases for the latest binaries, or Build Oni from source. Consider making a donation via OpenCollective BountySource if you find this project useful!

Features

Oni brings several IDE-like integrations to neovim:

And more coming - check out our Roadmap

Oni is cross-platform and supports Windows, Mac, and Linux.

If you're a Vim power user, and don't need all these features, check out our minimal configuration.

Installation

We have installation guides for each platform:

The latest binaries are available on our Releases page, and if you'd prefer to build from source, check out our Development guide.

Goals

The goal of this project is to provide both the full-fledged Vim experience, with no compromises, while pushing forward to enable new productivity scenarios.

Modern UX - The Vim experience should not be compromised by terminal limitations.
Rich plugin development - using JavaScript, instead of VimL.
Cross-platform support - across Windows, OS X, and Linux.
Batteries included - rich features are available out of the box - minimal setup needed to be productive.
Performance - no compromises, Vim is fast, and Oni should be fast too.
Ease Learning Curve - without sacrificing the Vim experience.

Vim is an incredible tool for manipulating text at the speed of thought. With a composable, modal command language, it is no wonder that Vim usage is still prevalent today.

However, going from thought to code has some different challenges than going from thought to text. Code editors today provide several benefits that help to reduce cognitive load when writing code, and that benefit is tremendously important - not only in terms of pure coding efficiency and productivity, but also in making the process of writing code enjoyable and fun.

The goal of this project is to give an editor that gives the best of both worlds - the power, speed, and flexibility of using Vim for manipulating text, as well as the rich tooling that comes with an IDE. We want to make coding as efficient, fast, and fun as we can!

Documentation

Check out the Wiki for documentation on how to use and modify Oni.
FAQ
Roadmap

Available Plugins

Some available plugins created by Oni users are listed below (if you'd like to add your plugin to this list please create a PR updating this README with the details).

Oni Touchbar Plugin - by jordan-arenstein
quickFind - by marene
- Themes
  - Night Owl

Contributing

There many ways to get involved & contribute to Oni:

Thumbs up existing issues if they impact you.
Create an issue for bugs or new features.
Review and update our documentation.
Try out the latest released build.
Help us develop:
- Review PRs
- Submit a bug fix or feature
- Add test cases
Create a blog post or YouTube video
Follow us on Twitter

Acknowledgements

Oni is an independent project and is made possible by the support of some exceptional people. Big thanks to the following people for helping to realize this project:

the neovim team, especially justinmk and tarruda - Oni would not be possible without their vision
jordwalke for his generous support, inspiration, and ideas. And React ;)
keforbes for helping to get this project off the ground
Akin909 for his extensive contributions
CrossR for polishing features and configurations
Cryza for the webgl renderer
tillarnold for giving us the oni npm package name
mhartington for his generous support
badosu for his support, contributions, and managing the AUR releases
All our current monthly sponsors and backers
All of our contributors - thanks for helping to improve this project!

Several other great neovim front-end UIs here served as a reference, especially NyaoVim and VimR. I encourage you to check those out!

Thank you!

Contributors

This project exists thanks to all the people who have contributed:

License

MIT License. Copyright (c) Bryan Phelps

Windows and OSX have a bundled version of Neovim, which is covered under Neovim's license

Bundled Plugins

Bundled plugins have their own license terms. These include:

typescript-vim (oni/vim/core/typescript.vim)
targets.vim (oni/vim/default/bundle/targets.vim)
vim-commentary (oni/vim/default/bundle/vim-commentary)
vim-unimpaired (oni/vim/default/bundle/vim-unimpaired)
vim-surround (oni/vim/default/bundle/vim-surround)
vim-reasonml (.vim files in oni/vim/core/oni-plugin-reasonml)

Searching Database…

11.2K ·GitHub

archived

What is this?

Oni is a modal text editor built on top of Neovim that adds modern IDE-like features such as autocompletion, quick info, fuzzy finding, and an embedded browser while keeping full Vim editing power.

Is this a Neovim plugin or a standalone editor?

It's a standalone desktop GUI application, written in TypeScript with React and Redux, that embeds Neovim as its core editing engine rather than running inside a terminal.

How do I install Oni?

Grab a prebuilt binary for your OS from the Releases page, or follow the Development guide to build it from source.

Do I need to install Neovim separately first?

No, on Windows and macOS Oni ships with a bundled copy of Neovim, so no separate Neovim install is required there.

Is this project still maintained?

No, this repository is archived and unmaintained; the authors moved development to Onivim 2 and the libvim library instead.

Does it run on Windows, Mac, and Linux?

Yes, Oni is cross-platform with dedicated installation guides and binaries for all three.

Can I write Oni plugins without learning VimL?

Yes, Oni's plugin system is designed around JavaScript instead of VimL, making it easier for web developers to extend the editor.

What IDE features does Oni add on top of plain Neovim?

It adds an embedded browser, quick info popups, code completion, syntax and compilation error display, a fuzzy finder, a status bar, and an interactive tutorial.

Are there community plugins and themes for Oni?

Yes, users have built extras like a Touchbar plugin, a quickFind plugin, and the Night Owl color theme, listed in the README.

What are similar projects?

neovide, LightTable, ideavim, Vim, helix, neomacs, neovim, SpaceVim

Which topics is it in?

modal-editing, rxjs, neovim, redux, text-editor, vim, ide, editor, deprecated, plugin, ui, desktop

Creator: onivim
Size: 39.4 MB
Stars: 11.2K
Updated: CommitApr 01 Releasev0.3.9Dec 17
Age: 9y
Commits · 90 Days