| .. | ||
| assets | ||
| ISSUE_TEMPLATE | ||
| PULL_REQUEST_TEMPLATE | ||
| workflows | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| dependabot.yml | ||
| FUNDING.yml | ||
| README.md | ||
| typos.toml | ||
nvf
Features
- Simple: One language to rule them all! Use Nix to configure everything, with additional Lua Support
- Reproducible: Your configuration will behave the same anywhere. No surprises, promise!
- Portable: nvf depends solely on your Nix store, and nothing else. No
more global binaries! Works on all platforms, without hassle.
- Options to install standalone, NixOS module or Home-Manager module.
- Customizable: There are almost no defaults to annoy you. nvf is fully customizable through the Nix module system.
- Not comfortable with a full-nix config or want to bring your Lua config? You can do just that, no unnecessary restrictions.
- Well-documented: Documentation is priority. You will never face undocumented, obscure behaviour.
- Idiomatic: nvf does things ✨ the right way ✨ - the codebase is, and will, remain maintainable for myself and any contributors.
Get Started
If you are not sold on the concepts of nvf, and would like to try out the default configuration before even thinking about installing it, you may run the following in order to take nvf out for a spin.
# Run the default package
nix run github:notashelf/nvf
This will get you a feel for the base configuration and UI design. Though, none of the configuration options are final as nvf is designed to be modular and configurable.
Tip
The flake exposes
#nixas the default package, providing minimal language support and various utilities. You may also use the#nixor#maximalpackages provided by the this flake to get try out different configurations.
It is as simple as changing the target output to get a different configuration. For example, to get a configuration with large language coverage, run:
# Run the maximal package
nix run github:notashelf/nvf#maximal
Similar instructions will apply for nix profile install. However, you are
recommended to instead use the module system as described in the manual.
Note
The
maximalconfiguration is quite large, and might take a while to build. To get a feel for the configuration, use the defaultnixconfiguration. Should you choose to try out themaximalconfiguration, using the binary cache as described in the manual is strongly recommended.
If you are convinced, proceed to the next section to view the installation instructions.
Documentation
Installation
The recommended way of installing nvf is using either the NixOS or the Home-Manager module, though it is completely possible and no less supported to install nvf as a standalone package, or a flake output.
See the rendered nvf manual for detailed and up-to-date installation guides, configurations, available options, release notes and more. Tips for installing userspace plugins is also contained in the documentation.
Tip
While using NixOS or Home-Manager modules,
programs.nvf.enableManpages = true;will allow you to view option documentation from the comfort of your terminal viaman 5 nvf. The more you know.
Please create an issue on the issue tracker if you find the documentation lacking or confusing. Any improvements to the documentation through pull requests are also welcome, and appreciated.
Getting Help
If you are confused, stuck or would like to ask a simple question; you may create an issue on the issue tracker to ask questions or report bugs.
We are not not yet on spaces like matrix or IRC, so please use the issue tracker for now.
Contributing
I am always looking for new ways to help improve this flake. If you would like to contribute, please read the contributing guide before submitting a pull request. You can also create an issue on the issue tracker before submitting a pull request if you would like to discuss a feature or bug fix.
Frequently Asked Questions
Q: What platforms are supported?
A: nvf actively supports Linux and Darwin platforms using standalone
Nix, NixOS or Home-Manager. Please take a look at the nvf manual for available
installation instructions.
Q: Can you add X?
A: Maybe! It is not one of our goals to support each and every Neovim
plugin, however, I am always open to new modules and plugin setup additions to
nvf. Use the appropriate issue template and I will consider a module
addition. As mentioned before, pull requests to add new features are also
welcome.
Q: A plugin I need is not available in nvf. What to do?
A: nvf exposes several APIs for you to be able to add your own
plugin configurations! Please see the documentation on how you may do this.
Q: Main branch is awfully silent, is the project dead?
A: No! Sometimes we branch out (e.g. v0.6) to avoid breaking
userspace and work in a separate branch until we make sure the new additions are
implemented in the most comfortable way possible for the end user. If you have
not noticed any activity on the main branch, consider taking a look at the
list of branches or the list of open pull requests. You may also consider
testing those release branches to get access to new features ahead of time and
better prepare to breaking changes.
Credits
Contributors
nvf would not be what it is today without the awesome people below. Special, heart-felt thanks to
- @fufexan - For the transition to flake-parts and invaluable Nix assistance.
- @FlafyDev - For getting home-manager module to work and Nix assistance.
- @n3oney - For making custom keybinds finally possible, and other module additions.
- @horriblename - For actively implementing planned features and quality of life updates.
- @Yavko - For the amazing nvf logo
- @FrothyMarrow - For seeing mistakes that I could not.
- @Diniamo - For actively submitting pull requests, issues and assistance with maintenance of nvf.
- @Gerg-l - For the modern Neovim wrapper, mnw, and occasional code improvements.
and everyone who has submitted issues or pull requests!
Inspiration
This configuration borrows from and is based on a few other configurations, including:
- @jordanisaacs's neovim-flake that this flake is originally based on.
- @sioodmy's dotfiles that inspired the design choices for UI and plugin defaults.
- @wiltaylor's neovim-flake for plugin and design ideas.
- @gvolpe's neovim-flake for plugin, design and nix concepts.
I am grateful for their previous work and inspiration, and I wholeheartedly
recommend checking their work out.
License
Following the license of the original neovim-flake, nvf has been made available under the MIT License. However, all assets and documentation are published under the CC BY License under explicit permission by the artist.