neovimcraft github

plugins configs about

NotAShelf/nvf

website github github
home-managerneovimneovim-flakenixnix-flakenixos-modulenvim
stars 1,589
issues 125
subscribers 7
forks 228
CREATED

UPDATED

 Features  Get Started   Documentation   Help   Contribute   FAQ   Credits 

Features

  • Simple: One language to rule them all! Use Nix to configure everything, with optional Lua support for robust configurability!
  • 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.
  • 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.
    • Lazyloading? We got it! Lazyload both internal and external plugins at will 💤 .
    • nvf allows ordering configuration bits using DAG (Directed acyclic graph)s. It has never been easier to construct an editor configuration deterministically!
    • nvf exposes everything you need to avoid a vendor lock-in. Which means you can add new modules, plugins and so on without relying on us adding a module for them! Though, of course, feel free to request them.
      • Use plugins from anywhere: inputs, npins, nixpkgs... You name it.
      • Add your own modules with ease. It's all built-in!
  • Well-documented: Documentation is priority. You will never face undocumented, obscure behaviour.
    • Any and all changes, breaking or otherwise, will be communicated in the release notes.
    • Refer to the FAQ section for answers to common questions.
  • Idiomatic: nvf does things ✨ the right way ✨ - the codebase is, and will, remain maintainable for myself and any contributors.
  • Community-Led: we would like nvf to be fully capable of accomplishing what you really want it to do. If you have a use case that is not made possible by nvf, please open an issue (or a pull request!)
    • Your feedback is more than welcome! Feedback is what drives nvf forward. If you have anything to say, or ask, please let us know.
    • Pull requests are always welcome. If you think the project can benefit from something you did locally, but are not quite sure how to upstream, please feel free to contact us! We'll help you get it done.

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 nix as the default package, which will be evaluated when you run nix build or nix run on this repo. It is minimal, and providing limited language support and various utilities. We also expose the maximal package, which you may choose to build if you'd like to see more of nvf's built-in modules. Please keep in mind that those are demo packages, nvf does not ship a default configuration if installed as a NixOS/Home-Manager module or via standalone method.

It is as simple as changing the target output in your nix run command 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 nvf manual.

[!NOTE] The maximal configuration is quite large, and might take a while to build. To get a feel for the configuration, use the default nix configuration. Should you choose to try out the maximal configuration, 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

nvf prides itself in its rich, intuitive documentation. The chapter below covers several methods through which you can install nvf. If you believe something is missing, or could be done better, please feel free to contact us!

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 are 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 via man 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 yet on spaces like matrix or IRC, so please use the issue tracker for now. The discussions tab can also be a place to request help from community members, or engage in productive discussion with the maintainers.

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.

Credits

Co-Maintainers

Alongside myself, nvf is developed by those talented folk. nvf would not be what it is today without their invaluable contributions.

  • @horriblename (Liberapay) - For actively implementing planned features and quality of life updates.
  • @Soliprem - For rigorously implementing missing features and excellent work on new language modules.
  • @Snoweuph

Please do remember to extend your thanks (financially or otherwise) if this project has been helpful to you.

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, great ideas and module additions.
  • @Yavko - For the amazing nvf logo
  • @FrothyMarrow - For seeing mistakes that I could not and contributing good ideas & code.
  • @Gerg-l 🐸 - For the modern Neovim wrapper, mnw, and occasional improvements to the codebase.
  • @Diniamo - For actively submitting pull requests, issues and assistance with co-maintenance of nvf.

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 under explicit permission by the author or authors.