aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Arctic Ice Studio <development@arcticicestudio.com>2017-01-29 10:24:09 +0100
committerGravatar Arctic Ice Studio <development@arcticicestudio.com>2017-01-29 10:24:09 +0100
commit8164a2854d83d07aaddd7b3f5bf948a95777d1d7 (patch)
treed548d6233792ecb7209dc0c651008528124c52e0 /README.md
parent5d63820776ec9b5fd75199d049e40ea439acbff7 (diff)
downloadnord-vim-8164a2854d83d07aaddd7b3f5bf948a95777d1d7.tar.gz
GHI-#13 Write the documentation for italic comments configuration
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 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.