From e18ab4e893f58a4a94d6df927884d8314e0f42d3 Mon Sep 17 00:00:00 2001 From: Sheldon Johnson Date: Sat, 23 Sep 2017 19:32:43 +1000 Subject: Implement comment brightness configuration feature GH-48 --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7c74a8e..4917782 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with su - [Activation](#activation) - [Configuration](#configuration) - [Italic comments](#italic-comments) + - [Comment contrast](#comment-contrast) - [Plugin Support](#plugin-support) - [UI Plugins](#ui-plugins) - [Language Plugins](#language-plugins) @@ -109,11 +110,28 @@ All options should be set **before** the [activation](#activation) command! Enable to use italic font for all comments. To adhere to the Nord style guide this option is disabled by default. -It can be enabled by setting the `g:nord_italic_comments` variable to `1`. +It can be enabled by setting the `g:nord_italic_comments` variable to `1`. + ```vim let g:nord_italic_comments = 1 ``` +### Comment contrast +**This option should only be enabled if your terminal emulator supports 24bit true color (16 million colors)!** + +This option is only visible if `termguicolors` is enabled in your `~/.vimrc` or set via `:set termguicolors`! + +The comment brightness can be increased by 1 - 20 percent. It can be enabled by setting the `g:nord_comment_brightness` +variable to a number between `1` and `20`. + +```vim +let g:nord_comment_brightness = 12 +``` + +To adhere to the Nord style guide this option uses `nord3` by default. + +More information about true color and the support in various terminals can be found in [this gist][gist-true-color]. + ## Plugin Support Nord Vim provides support for many third-party language- and the UI plugins. @@ -159,9 +177,9 @@ Please report issues/bugs, feature requests and suggestions for improvements to

+[gist-true-color]: https://gist.github.com/XVilka/8346728 [scrot-readme-default-profile]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-readme-default-profile.png [scrot-readme-lazy-profile-change]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-readme-lazy-profile-change.png - [scrot-lang-c]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-c.png [scrot-lang-css]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-css.png [scrot-lang-html]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-html.png -- cgit v1.2.3-70-g09d2