diff options
author | aktersnurra <gustaf.rydholm@gmail.com> | 2022-10-29 18:19:38 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-29 18:19:38 +0200 |
commit | 2951af7bbd839ebef25e33f8bd01bd5c501f76c8 (patch) | |
tree | f1829cc7af1fc0c5900b23055d12bb0446962cfb /README.md | |
parent | 3234b296d7f70cc78ac37a51fc3cff28e7871812 (diff) |
Update how options and colorscheme is set (#12)
* Update loading of colorscheme
* Fix typo
* Fix setting of style
* Fix highlighting
* Unpack style
* Add empty table if props are nil
* Fix concat of tables
* Fix typo
* Update settings
* Add call set in settings
* Add deep extend
* Remove style field
* Update README
BREAKING CHANGE: updates how the colorscheme is set and the structure of the options table
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 35 |
1 files changed, 23 insertions, 12 deletions
@@ -4,23 +4,34 @@ An attempt at a color scheme that does not look like a clown puked up the source ![image](https://gustafrydholm.xyz/images/no-clown-fiesta.png?) -## Setup -The default configuration is: +## Usage + +To enable this colorscheme: + +```vim +colorscheme no-clown-fiesta +``` + ```lua -{ - transparent_background = palette.bg, - comments = "NONE", - keywords = "NONE", - functions = "NONE", - variables = "NONE", - type = "NONE", -} +vim.cmd[[colorscheme no-clown-fiesta]] ``` -These can be overridden when activating the plugin, e.g.: +To override the default settings you need to call setup before enabling the +colorscheme. No-clown-fiesta will use these settings, unless you call setup +and override these. ```lua -require("no-clown-fiesta").setup({ type = "bold,italic" }) +require("no-clown-fiesta").setup({ + transparent = false, -- Enable this to disable the bg color + styles = { + -- You can set any of the style values specified for `:h nvim_set_hl` + comments = {}, + keywords = {}, + functions = {}, + variables = {}, + type = { bold = true }, + }, +}) ``` ## Supported Plugins |