Lush is a colorscheme creation aid for Neovim. It gives you real time feedback as you edit, as well as color manipulation tools and some aids building a structured colorscheme.

Lush colorschemes can easily be exported for use without Lush, either as a lua table, vimscript commands or any other format. They can also be imported into other Lua systems to access your color data.

See some colorschemes Made with Lush.

• Announcements
• Requirements
• Installation
• Interactive Tutorial
• Guides
• See Also

Lush was originally written for Neovim 0.4 (!!!). I had just swapped from Vim to Neovim, wanted to learn Lua as well as make my own colorscheme. I read an article by Leaf about creating DSLs in lua and rolled all that into Lush.

At the time, there was no native support for writing colorschemes in Lua and being able to export my Neovim colorscheme to use with AwesomeWM was a neat trick. Neovim's APIs have matured and writing colorschemes in Lua is now quite simple. You can approximate a custom implementation of Lush with some metatables and glue.

Lush will still be maintained but the value proposition of Lush is different to what it was at the time of release and creators may want to take that under consideration.

See issue for new syntax. Syntax is subject to change.

• 2022-05-12: Neovim 0.7 is now a requirement, the 1.0.1 tagged version is the last 0.5 compatible release.
• 2021-11-05: Deprecation warning, the compiler exclude_keys option has been deprecated in favour of the build system,
  • See build guide for details.

• Neovim 0.7 or greater required to use Lush as a development tool
• termguicolors enabled for true color support

Install via any package management system, for example, paq:

require paq { 'rktjmp/lush.nvim' }

Via Lazy:

return {
    "rktjmp/lush.nvim",
    -- if you wish to use your own colorscheme:
    -- { dir = '/absolute/path/to/colorscheme', lazy = true },
}

Run :LushRunTutorial for an Interactive guided tour of using Lush.

• Create your new colorscheme with lush-template (and how to import a non-lush colorscheme)
• Extend an Lush existing colorscheme, or how users can configure your colorscheme
• Export your colorscheme for use without Lush, or to any format with Shipwright
• FAQ

• Vim Help
• Change Log
• TODO