lush.nvim icon indicating copy to clipboard operation
lush.nvim copied to clipboard

Create Neovim themes with real-time feedback, export anywhere.

Lush Header

Lush CI

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.

  • Annoucements
  • Requirements
  • Installation
  • Interactive Tutorials
  • Guides
  • See Also

Annoucements

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

Requirements

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

Installation

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

require paq { 'rktjmp/lush.nvim' }

Interactive Tutorials

Lush Demo

There are two interactive tutorials provided,

  • :LushRunQuickstart which will give you a few-minute overview of Lush's creation features. (Or open lush_quick_start.lua in the examples folder.)

  • :LushRunTutorial, a more in-depth guide through various ways to apply Lush. (Or open lush_tutorial.lua in the examples folder).

Guides

  • 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

See Also

  • Vim Help
  • Change Log
  • TODO