aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Arctic Ice Studio <development@arcticicestudio.com>2017-02-02 05:59:23 +0100
committerGravatar GitHub <noreply@github.com>2017-02-02 05:59:23 +0100
commitdc6149f4375040f3c7b2a5fea99e15aacce6c807 (patch)
treec1656b3e1fe5e0336ecdf43d0c36841dce4c99fe /README.md
parentdbc5c4d555ad154438d94f750384c1ce3a2a7da8 (diff)
parent8164a2854d83d07aaddd7b3f5bf948a95777d1d7 (diff)
downloadnord-vim-dc6149f4375040f3c7b2a5fea99e15aacce6c807.tar.gz
Merge pull request #16 from arcticicestudio/feature/ghi-#13-italic-comments-support
#13 Italic comments support
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 872a5a3..4be608c 100644
--- a/README.md
+++ b/README.md
@@ -99,6 +99,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.