Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rktjmp/lush.nvim
Create Neovim themes with real-time feedback, export anywhere.
https://github.com/rktjmp/lush.nvim
color-scheme lua neovim neovim-colorscheme neovim-plugin
Last synced: 25 days ago
JSON representation
Create Neovim themes with real-time feedback, export anywhere.
- Host: GitHub
- URL: https://github.com/rktjmp/lush.nvim
- Owner: rktjmp
- License: mit
- Created: 2020-11-17T05:46:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T05:22:21.000Z (3 months ago)
- Last Synced: 2024-09-26T23:21:07.659Z (about 1 month ago)
- Topics: color-scheme, lua, neovim, neovim-colorscheme, neovim-plugin
- Language: Lua
- Homepage:
- Size: 5.89 MB
- Stars: 1,463
- Watchers: 10
- Forks: 48
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - rktjmp/lush.nvim - Define Neovim themes as a DSL in Lua, with real-time feedback. (Colorscheme / Colorscheme Creation)
README
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**](made_with_lush/README.md#made-with-lush).
- [Announcements](#Announcements)
- [Requirements](#requirements)
- [Installation](#installation)
- [Interactive Tutorial](#interactive-tutorial)
- [Guides](#guides)
- [See Also](#see-also)
Experimental Treesitter Interface
---
[See issue for new syntax](https://github.com/rktjmp/lush.nvim/issues/109).
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](BUILD.md) 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:
```vim
require paq { 'rktjmp/lush.nvim' }
```
Via Lazy:
```lua
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)](CREATE.md)
- [Extend an Lush existing colorscheme, or how users can configure your
colorscheme](EXTEND.md)
- [Export your colorscheme for use without Lush, or to any format with Shipwright](BUILD.md)
- [FAQ](FAQ.md)
See Also
--------
- [Vim Help](doc/lush.txt)
- [Change Log](CHANGELOG.md)
- [TODO](TODO.md)