https://github.com/mvllow/lilvim
a lil, modular config
https://github.com/mvllow/lilvim
lua neovim
Last synced: 4 months ago
JSON representation
a lil, modular config
- Host: GitHub
- URL: https://github.com/mvllow/lilvim
- Owner: mvllow
- Created: 2022-03-17T21:01:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-28T15:40:09.000Z (5 months ago)
- Last Synced: 2025-03-18T02:44:14.891Z (4 months ago)
- Topics: lua, neovim
- Language: Lua
- Homepage:
- Size: 111 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# lilvim
> a lil, modular config
## Features
- 🪴 Self-contained modules
- 📦 Prioritised built-in functionality
- 🥟 Deliciously simple to extend
## Usage
```sh
# Notice the destination folder is lilvim, not nvim
git clone https://github.com/mvllow/lilvim ~/.config/lilvim
# Run lilvim by setting the NVIM_APPNAME environment variable
NVIM_APPNAME=lilvim nvim
```
Alternatively, you may pull any module into your own config.
## Modules
All modules are loaded in `init.lua`.
_**[lil-editing](lua/lil-editing.lua)**_\
General options and keymaps
_**[lil-lsp](lua/lil-lsp.lua)**_\
Language servers and diagnostics
_**[lil-search](lua/lil-search.lua)**_\
File discovery and text navigation
_For not-so-lil module extensions, head over to our [wiki](https://github.com/mvllow/lilvim/wiki)_
## Principles
> Heavily inspired by [Rational Emacs](https://github.com/SystemCrafters/rational-emacs)
### Minimal and modular by design
This project includes several self-contained modules which handle their own vim options, keymaps and configurations, contrary to another popular approach of isolating those three categories.
### Prioritise built-in Neovim functionality
We have designed lilvim to demonstrate the capabilities of vanilla Neovim and lower the platform's barrier to entry for new users. Our approach encourages users to enjoy the benefits of a lightweight environment by first embracing the platform, then supplementing with plugins as needed.
### Statistics
Lines of code may not be the best metric, but NASA’s fourth rule in _[Rules for Developing Safety Critical Code](https://pixelscommander.com/wp-content/uploads/2014/12/P10.pdf)_ suggests keeping functions under 60 lines. While we’re not launching rockets here, this lil config is meant to be compact and easy to follow.
```
$ tokei ./lilvim/**/*.lua
===============================================================================
Language Files Lines Code Comments Blanks
===============================================================================
Lua 4 169 56 96 17
===============================================================================
Total 4 169 56 96 17
===============================================================================
```
## Related
[NativeVim](https://github.com/boltlessengineer/NativeVim) provides several features and has great documentation. This is a great place to look for inspiration without sacrificing features.
There are plenty of projects that provide a framework of abstractions to simplify the learning curve of using Neovim over something like Sublime Text or Visual Studio Code. Check out [LazyVim](https://github.com/LazyVim/LazyVim) or [AstroVim](https://github.com/kabinspace/AstroVim) if you want a great batteries-included Neovim configuration or [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)—a more robust and feature-rich starting point for your own config.
## Contributing
We welcome and appreciate contributions of any kind. Please open an issue to discuss the addition of new modules.