diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 12e6aaf..96451d5 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -29,7 +29,7 @@ jobs: # Output vimdoc project name vimdoc: zenbones pandoc: doc/zenbones.md - description: "A contrast-focused vim/neovim colorscheme" + description: "A collection of contrast-based vim/neovim colorschemes" version: "Vim v8.1 / Neovim 0.5.0" - uses: stefanzweifel/git-auto-commit-action@v4 with: diff --git a/README.md b/README.md index 59ca889..9b90dc8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Zenbones is a vim/neovim colorscheme designed to highlight code using contrasts and font variations. Colors are tasked only for other roles such as diagnostics, diffs, search matches. +It is carefully crafted for extensibility. You can +[create your own zenbones-based colorscheme](doc/zenbones.md#create-your-own-colorscheme) +or try the [built-in collection](#usage). + ![Zenbones main image](https://user-images.githubusercontent.com/7200153/133883977-116795f3-c602-45f0-8907-b89c8d0b2f82.jpg)

@@ -35,15 +39,17 @@ use { Just apply the colorscheme as usual: ```vim +set termguicolors + colorscheme zenbones " light colorscheme zenflesh " dark -colorscheme zenwritten " Zero hue and saturation version -colorscheme neobones " https://neovim.io flavor -colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com -colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest -colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes -colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette +colorscheme zenwritten " Zero hue and saturation version +colorscheme neobones " https://neovim.io flavor +colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com +colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest +colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes +colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette ``` ## [Configuration and other documentations](doc/zenbones.md) diff --git a/doc/zenbones.md b/doc/zenbones.md index 1dc60eb..330f372 100644 --- a/doc/zenbones.md +++ b/doc/zenbones.md @@ -9,15 +9,17 @@ as diagnostics, diffs, search matches. Just apply the colorscheme as usual: ```vim +set termguicolors + colorscheme zenbones " light colorscheme zenflesh " dark -colorscheme zenwritten " Zero hue and saturation version -colorscheme neobones " https://neovim.io flavor -colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com -colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest -colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes -colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette +colorscheme zenwritten " Zero hue and saturation version +colorscheme neobones " https://neovim.io flavor +colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com +colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest +colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes +colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette ``` It works pretty much the same as the first one but pretty handy when extending @@ -180,7 +182,7 @@ more options. ### Create your own colorscheme -You can ultimately create your own colorscheme that is based on Zenbones by +You can ultimately create your own colorscheme that is based on zenbones by defining a palette and generating a specs. Best way to demonstrate this is through an example. Let's make a zenbones-flavored Gruvbox colorscheme called `gruvbones`.