Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mvllow/lilvim
a lil, modular config
https://github.com/mvllow/lilvim
lua neovim
Last synced: 21 days 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 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-21T19:11:21.000Z (4 months ago)
- Last Synced: 2024-10-19T08:17:07.299Z (about 1 month ago)
- Topics: lua, neovim
- Language: Lua
- Homepage:
- Size: 86.9 KB
- Stars: 10
- 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. Individual modules rely on [mini.deps](https://github.com/echasnovski/mini.deps) for managing packages. You may opt for your own package manager or manually cloning the required dependencies. See `:help packages` for more information on the builtin package manager.
## Modules
All modules are loaded in `init.lua`. If using a standalone module, please handle installing the necessary dependencies. For the best support, we recommended installing [mini.deps](https://github.com/echasnovski/mini.deps?tab=readme-ov-file#installation).
_**[lil-editing](lua/lil-editing.lua)**_\
General options and keymaps
_**[lil-formatting](lua/lil-formatting.lua)**_\
Formatters and only formatters
_**[lil-lsp](lua/lil-lsp.lua)**_\
Language servers and diagnostics
_**[lil-search](lua/lil-search.lua)**_\
File discovery and text navigation
_**[lil-ui](lua/lil-ui.lua)**_\
Treesitter and interface options
_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 options, keymaps, and plugins, 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
```
~/.config/lilvim (main)> tokei **/*.lua
===============================================================================
Language Files Lines Code Comments Blanks
===============================================================================
Lua 6 308 159 122 27
===============================================================================
Total 6 308 159 122 27
===============================================================================
```
## Related
There are plenty of projects that provide a framework of abstractions to simplify the learning curve of using Neovim over something like VSCode. Check out [LunarVim](https://github.com/LunarVim/LunarVim) or [AstroVim](https://github.com/kabinspace/AstroVim) if you want a great batteries-included Neovim configuration.
## Contributing
We welcome and appreciate contributions of any kind. Please open an issue to discuss the addition of new modules.