rktjmp/lush.nvim

github

colorschemecolorscheme-creation

1,641

13

11

48

CREATED

2020-11-17

UPDATED

2024-08-16

---

Lush

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

Experimental Treesitter Interface

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

Announcements

• 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' }

Via Lazy:

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

Interactive Tutorial

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

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