From 8164a2854d83d07aaddd7b3f5bf948a95777d1d7 Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Sun, 29 Jan 2017 10:24:09 +0100 Subject: GHI-#13 Write the documentation for italic comments configuration --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 8e60263..4470316 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,20 @@ or on specific events. Plug 'arcticicestudio/nord-vim', { 'on': 'NERDTreeToggle' } ``` +### Configuration +All options should be set **before** the [activation](#activation) command! + +#### Italic comments +**This option should only be enabled if your terminal emulator supports italics!** + +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`. +```vim +let g:nord_italic_comments = 1 +``` + ## Plugin Support Nord Vim provides support for many third-party language- and the UI plugins. -- cgit v1.2.3-70-g09d2