NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-26 15:06:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
A highly modular, extensible and distro-agnostic Neovim configuration framework for Nix/NixOS.
1344 commits 14 branches 5 tags 11 MiB
Nix 100%
Find a file
diniamo 2dd1be0b45 vim.maps rewrite (#352) 
* feat: rewrite vim.maps

* modules/mappings: enable silent by default

* docs: add entry for vim.maps rewrite

* lib/binds: improve code, adjust functions to new api
2024-08-24 14:35:50 +02:00
.github --- 2024-05-20 19:43:05 +00:00
docs vim.maps rewrite (#352) 2024-08-24 14:35:50 +02:00
flake treewide: refactor custom lib, merge lists in hm/nixos module (#323) 2024-07-11 22:49:44 +00:00
lib vim.maps rewrite (#352) 2024-08-24 14:35:50 +02:00
modules vim.maps rewrite (#352) 2024-08-24 14:35:50 +02:00
patches fix(flutter-tools): bug where dart lsp is not found 2023-06-26 12:31:51 +02:00
.editorconfig CI: add more stict checking 2023-10-20 11:59:21 +03:00
.envrc dev: rebase on a less personalized neovim flake 2023-02-01 22:11:37 +03:00
.gitignore treewide: remove trailing whitespaces 2023-10-20 11:59:28 +03:00
configuration.nix plugins/visuals(indent-blankline): move to setupOpts (#329) 2024-07-12 15:47:33 +00:00
flake.lock flake.lock: Update (#363) 2024-08-24 10:47:26 +00:00
flake.nix plugins/new-file-template: init module (#350) 2024-08-08 18:45:33 +00:00
LICENSE docs: clean up remaining mentions of neovim-flake 2024-04-27 16:04:09 +03:00
release.json meta: mark as release 2024-04-27 16:38:44 +03:00

.github/README.md

nvf Logo

nvf

A highly modular, configurable, extensible and easy to use Neovim configuration framework in Nix. Designed for flexibility and ease of use, this flake allows you to easily configure your Neovim instance with a few lines of Nix code.

Get Started

Using nix CLI

If you would like to try out the configuration before even thinking about installing it, you can run the following command

nix run github:notashelf/nvf

This will get you a feel for the base configuration and UI design. The flake exposes #nix as the default package, providing minimal language support and various utilities.You may also use #nix, #tidal or #maximal 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 tidal support, run:

nix run github:notashelf/nvf#tidal

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 maximal configuration is massive and will take a while to build. To get a feel for the configuration, use the default nix or tidal configurations. Should you choose to try out the maximal configuration, using the binary cache as described in the manual is strongly recommended.

Documentation

See the nvf Manual for detailed installation guides, configurations, available options, release notes and more. Tips for installing userspace plugins is also contained in the documentation.

If you want to dive right into trying nvf you can get a fully featured configuration with nix language support by running:

nix run github:notashelf/nvf#nix

Please create an issue on the issue tracker if you find the documentation lacking or confusing. I also appreciate any contributions to the documentation.

Help

You can create an issue on the issue tracker to ask questions or report bugs. I am 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.

FAQ

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 appropritate issue template and I will consider a module addition.

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 available to 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

Credits

Contributors

Special thanks to

  • @fufexan - For the transition to flake-parts
  • @FlafyDev - For getting the home-manager to work
  • @n3oney - For making custom keybinds finally possible
  • @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

and everyone who has submitted issues or pull requests!

Inspiration

This configuration borrows from and is based on a few other configurations, including:

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.