Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Theory-of-Everything/nii-nvim

A minimal neovim configuration
https://github.com/Theory-of-Everything/nii-nvim

config hacktober linux lua neovim neovim-config nvim telescope vim

Last synced: about 2 months ago
JSON representation

A minimal neovim configuration

Awesome Lists containing this project

README 

        
This project is unmaintained


I have no desire to continue work on this project.

People who wish to maintain this project, please reach out to me.




















 nii-nvim:
a no-nonsense neovim configuration






 img








  Docs

   • 

  Install

   • 

  Contribute

  • 

  Support

  







  

[![Lua](https://img.shields.io/badge/Made%20With-Lua-2C2D72?style=for-the-badge&logo=lua&logoColor=white)]()

[![Repo_Size](https://img.shields.io/github/languages/code-size/theory-of-everything/nii-nvim?color=orange&label=Repo%20Size&style=for-the-badge)]()



  




Nii-nvim is a very minimal neovim configuration focused on creating a functional editor with a minimal amount of code. Nii-nvim also keeps the user in mind by being very extensible and well documented.

Nii-nvim is finally out of heavy development, thus the project should be considered *mostly stable*



# NOTICE!!!!!!!!



You are looking at the obsolite `master` branch, if you wish to migrate your configs and pull a new version of nii-nvim,

please take a look at the [docs](https://docs.theoryware.net/nii-nvim/migration-branch/)!



**NOTE:** Active development will be moved to my [sr.ht repo](https://git.sr.ht/~theorytoe/nii-nvim) for this project, It is prefered that you leave issues and patches/pull requests over there, rather than opening issue sand prs on github. However i will still keep an eye on github too.



## Why nii-nvim?

There are many neovim configurations that exist (i.e. NvChad, Lunar Vim, etc.), however, many of these configurations suffer from a host of problems.

 - Some configurations (like NvChad), have very abstracted and complex codebases.

 - Others rely on having as much overall functionality as possible (like LunarVim).



While none of this is bad, there are some problems that can arise from these choices:

 - Complex codebases lead to less freedom for end-user extensibility and configuration, as there is more reliance on the maintainer of said code.

 - Users may not use half of what is made available to them simply because they don't need all of that functionality, so all of it may not be necessary.



nii-nvim provides a solution to these problems by providing only the necessary code in order to make a functioning configuration.

The end goal of nii-nvim is to be used as a base config for users to extend and add upon, leading to a more unique editing experience.



Also the name is cute. 	(・3・)



## Requirements

- neovim 5.0 or greater

- fzf

- git

- A Nerd Font

- ripgrep

- Python 3



## Features

- Heavy focus on both in-source documentation as well as external documentation.

- Sane Keybinds for extra added functionality

- Small codebase for easy extensibility

- A handful of plugins that build off neovim's strengths

- Swag (and Minimalism!!)



## Contributing



PLEASE BE WARY! If you are thinking of contributing, please wait. I am currently in the process of moving this project to sr.ht.

Contributions are always appreciated! If you would like to contribute, please check out [CONTIBUTING.md](./CONTRIBUTING.md) in the repository root.

If you like sending patches using git's built-in email features, please send all patches to the [nii-nvim-devel](mailto:~theorytoe/[email protected]) mailing list.



## Support/Community

If you are looking for help, or are looking for others to interact with, you can join the "official" Matrix room and Discord server

 - Matrix Room: [#nii-nvim:halogen.city](https://matrix.to/#/#nii-nvim:halogen.city)

 - Discord Server: [Invite Link (H6WY7cUkfw)](https://discord.gg/H6WY7cUkfw)



You can also shoot an email to the mailing list:

 - [~theorytoe/[email protected]](https://lists.sr.ht/~theorytoe/nii-nvim-discuss)



# Screenshots

## Functionality Showcase

![lsp](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/feat_completion.png)

![hop](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/feat_hop.png)

![tree](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/feat_tree.png)

![docs](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/helpdoc.png)

![file_find](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/telescope_0.png)

![git](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/telescope_1.png)



## Theme Showcase

![Everforest](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/scrot_everforest.png)

![Bluewery](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/scrot_bluewery.png)

![Gruvbox-material](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/scrot_gruvboxmaterial.png)

![Nord](https://raw.githubusercontent.com/Theory-of-Everything/imagehost/main/nii-nvim/scrot_nord.png)