​
How does NyxVim work?

NyxVim’s starter repo is the actual config, and it uses the main NyxVim repo as a plugin.

NyxVim

This is the main repo for NyxVim and its development. It contains all the plugins, options, mappings, autocmds All of its modules are in /nyxvim

Starter (Windows)

Config which uses the NyxVim repo as a plugin Users will be using the starter config as a base Imports NyxVim modules, e.g., require("nyxvim.options")

Nyxrc.lua

Used to configure UI & base46 plugin Meant to have the structure of nyxconfig.lua Should be in your config’s /lua folder

​
Themes

You can see all the themes with the following keymap: <leader> + th.
The leader key is the space in NyxVim.

​
Mappings

If you want to know all the keymaps, you can run the following commands:

NyxCheatsheet

Run :NyxCheatsheet to see a quick overview of keymaps Provides a concise summary of essential shortcuts

Telescope keymaps

Run :Telescope keymaps for a searchable list of all keymaps Offers a comprehensive, filterable view of all available keybindings Allows for easy discovery and lookup of specific commands

​
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.