aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar dylnmc <dylnmc@gmail.com>2018-03-09 23:04:21 -0500
committerGravatar Arctic Ice Studio <development@arcticicestudio.com>2018-06-23 17:57:34 +0200
commit3b306306cb94e8e31769504bffb8abb440b41459 (patch)
treeea50aab1d76eb36d275c3c6a1bd9275128dfc4aa /README.md
parent9e7addbc14cf7d43a086536d587ab18c94c832cd (diff)
downloadnord-vim-3b306306cb94e8e31769504bffb8abb440b41459.tar.gz
Implement config to toggle underlines
All underlines can be disabled globally with the "g:nord_underline" config. GH-106
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index c56eb13..cbf499b 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 Support](#italic-support)
+ - [Underline Support](#underline-support)
- [Italic Comments](#italic-comments)
- [Uniform Status Lines](#uniform-status-lines)
- [Comment Contrast](#comment-contrast)
@@ -141,6 +142,22 @@ let g:nord_italic = 1
<p align="center"><strong>Italic formatting in Markdown</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-italic-markdown.png"/></p>
+### Underline Support
+
+**This option should only be enabled if your terminal emulator supports underlines!**
+
+Can be enabled to support underlined text.
+
+Most terminals are not capable to handle underlines right so Nord disables these for terminals by default while it should work out-of-the-box™ in GUI mode.
+
+Set `g:nord_underline` to `1` to enforce displaying underlines.
+
+```vim
+let g:nord_underline = 1
+```
+
+<p align="center"><strong>Underlined Text</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-underline.png"/></p>
+
### Italic Comments
**This option only takes effect if the option for [italic text support](#italic-support) has been enabled!**