GUIZHONG.NVIM

A framework for creating Neovim colorschemes.

CHARACTER LORE

There once was an archon. Skilled in the arts of creation, she created much joy for the humans whose care she had been charged with. These joys were created through the invention of ingenious devices.

- Records of Liyue historians

Teach with wisdom, be bound by virtue, fortify the bones, unite in ambition.

- Guizhong, Goddess of earthen elements

ABOUT

This repository contains the source code for a Lua plugin for Neovim enabling users to build a beautiful Neovim colorscheme in mere minutes. The project was named after the goddess of invention in Genshin Impact, Guizhong (归终).

INSTALLATION

Lazy.nvim

return {
  'alyxshang/guizhong.nvim'
}

Nuwa.nvim

-- Installing the package.
nuwa.installPackage(
  "https://source.alyxshang.boo",
  "alyxshang",
  "guizhong.nvim"
)

USAGE

To understand how to use Guizhong.nvim, please peruse any of the colorschemes made with Guizhong.nvim.

CONTRIBUTING

To contribute, please follow these steps:

• Fork this repository.
• Add a module for the plugin you want to support in the lua/guizhong directory.
• Import the module inside the file lua/guizhong/setter.lua and include the call inside the setHighlights function with the supplied palette as an argument.
• Test your change with an existing colorscheme or your own.
• Commit and push your change.
• Add your plugin to the Supported Plugins section.
• File a pull request.

SUPPORTED PLUGINS

Any of these plugins can be specified as optional dependencies for Guizhong.nvim.

• noice.nvim
• telescope.nvim
• nvim-tree.lua
• nvim-treesitter
• bufferline.nvim
• gitsigns.nvim

MADE WITH GUIZHONG.NVIM

VAMP.NVIM

A mysterious pink Neovim colorscheme.

CHANGELOG

Version 0.1.0

• Initial release.
• Upload to GitHub.

NOTE 📜

• Guizhong.nvim by Alyx Shang.
• Licensed under the FSL v1.