​
Overview

NyxVim leverages lazy.nvim for efficient plugin management. This powerful tool allows for lazy loading and easy configuration of plugins.

Check out the list of default plugins included in NyxVim.

​
Lazy Loading

We employ lazy loading for approximately 95% of our plugins to optimize startup time. We strongly recommend that you follow this practice when adding your own plugins.

Failing to lazy load plugins can significantly slow down NyxVim’s startup time.

To implement lazy loading effectively:

  1. Familiarize yourself with the lazy.nvim plugin specs.
  2. Utilize available options for lazy loading in your plugin configurations.
  3. Always strive to lazy-load plugins when possible.

​
Managing Plugins

All default NyxVim plugins are set with lazy = true. If you want a plugin to load at startup, you need to set lazy = false.

​
Plugin Configuration

Create a file named plugins/custom.lua (or any other name) with the following structure:

local plugins = {
  -- Your plugin configurations go here
}

return plugins

​
Plugin Configuration Examples

Here are some examples of how to configure plugins:

{ "elkowar/yuck.vim", lazy = false }

​
Best Practices

  1. Lazy Load: Always try to lazy load plugins when possible.
  2. Minimal Configuration: Only override necessary options to keep configurations clean.
  3. Use Built-in Features: Leverage lazy.nvim’s built-in features for efficient plugin management.
  4. Document Your Changes: Add comments to explain any complex configurations or overrides.

Remember to run :Lazy sync after making changes to your plugin configurations to ensure all changes are applied.

​
Need Help?

If you’re having trouble with any NyxVim features or have questions:

  • Check our FAQ section for common questions and answers.
  • Join our Discord community to chat with other NyxVim users.
  • Participate in GitHub Discussions to engage with the NyxVim community, share ideas, and get help.
  • For bug reports or feature requests, open an issue on our GitHub repository.