diff options
| -rw-r--r-- | CHANGELOG.md | 240 | ||||
| -rw-r--r-- | README.md | 127 | ||||
| -rwxr-xr-x | assets/scrot-config-comment-contrast-java-15-percent.png | bin | 0 -> 162422 bytes | |||
| -rwxr-xr-x | assets/scrot-config-comment-contrast-java-default.png | bin | 0 -> 159234 bytes | |||
| -rwxr-xr-x | assets/scrot-config-comment-contrast-js-12-percent.png | bin | 0 -> 159845 bytes | |||
| -rwxr-xr-x | assets/scrot-config-comment-contrast-js-default.png | bin | 0 -> 157057 bytes | |||
| -rw-r--r-- | assets/scrot-config-italic-markdown.png | bin | 0 -> 12791 bytes | |||
| -rwxr-xr-x | autoload/airline/themes/nord.vim | 2 | ||||
| -rwxr-xr-x | autoload/lightline/colorscheme/nord.vim | 2 | ||||
| -rwxr-xr-x | colors/nord.vim | 2 |
10 files changed, 317 insertions, 56 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index bf73b50..d073c12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,19 +4,169 @@ --- +# 0.7.0 + + [](https://github.com/arcticicestudio/nord-vim/projects/10) [](https://github.com/arcticicestudio/nord-vim/milestone/9) + +## Features + +❯ Added a new [configuration to allow users to increase the comment brightness][readme-config-comment-brightness] by 1 - 20 percent. It can be enabled by setting the `g:nord_comment_brightness variable` to a number between `1` and `20`. (#48 in PR #56, @drzel, e18ab4e8) + +**This option should only be enabled if the terminal supports 24bit true color (16 million colors) and requires the `termguicolors` option to be set is in `~/.vimrc` or via `:set termguicolors`!** + +<p align="center"><strong>Default and 15% increased</strong><br><img src="https://user-images.githubusercontent.com/7836623/30772939-a65c92b6-a066-11e7-92f2-2f7089fe7700.png"/><br><img src="https://user-images.githubusercontent.com/7836623/30772941-b85577d0-a066-11e7-9c64-b9dab6736034.png"/></p> + +<p align="center"><strong>Default and 12% increased</strong><br><img src="https://user-images.githubusercontent.com/7836623/30772949-ea459978-a066-11e7-8092-9e6522f9b7bf.png"/><br><img src="https://user-images.githubusercontent.com/7836623/30772950-eb8c2c84-a066-11e7-92d2-a64ac5f20521.png"/></p> + +To adhere to the Nord design guidelines this option uses `nord3` by default. + +This is a reference table if users like to use the same increased contrast values as provided by the [Nord Atom Syntax accessibility custom comment contrast theme setting][nord-atom-syntax-pr-47] which are calculated using the LESSCSS [`lighten`][lesscss-doc-fn-lighten] function. + +| Increased by | Calculated value | +| --- | --- | +| 1% | `#4e586d` | +| 2% | `#505b70` | +| 3% | `#525d73` | +| 4% | `#556076` | +| 5% | `#576279` | +| 6% | `#59647c` | +| 7% | `#5b677f` | +| 8% | `#5d6982` | +| 9% | `#5f6c85` | +| 10% | `#616e88` | +| 11% | `#63718b` | +| 12% | `#66738e` | +| 13% | `#687591` | +| 14% | `#6a7894` | +| 15% | `#6d7a96` | +| 16% | `#6f7d98` | +| 17% | `#72809a` | +| 18% | `#75829c` | +| 19% | `#78859e` | +| 20% | `#7b88a1` | + +More information about true color and the support in various terminals can be found in [this gist][gist-colors-in-terminals]. + +❯ Added a new [configuration for a uniform *diff* background color][readme-config-uniform-diff-background]. (#60 in PR #61 #62 #65, @dylnmc @aidanharris @berkin, 958322d0) + + + +Setting `g:nord_uniform_diff_background` to `1` enables the uniform diff background using `nord1`: + + + +❯ Added a new [configuration to use uniform activate- and inactive status line backgrounds][readme-config-uniform-statusline-background]. (#37 in PR #58, @dylnmc @DenniJensen, 93056802) + +<p align="center"><strong>Default status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines-default.png"/></p> + +<p align="center"><strong>Uniform status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines.png"/></p> + +❯ Added a new [configuration to explicitly enable italic text formatting][readme-config-italic]. (#88 in PR #89, @lokesh-krishna @dylnmc, dbfc55ff) + +**Please note that this option should only be enabled if the used terminal supports italics!** + +<p align="center"><strong>With enabled option for italic comments</strong><br><img src="https://user-images.githubusercontent.com/7836623/34433722-6c7f0a4e-ec81-11e7-8af9-ebc227b6535e.png"/></p> + +<p align="center"><strong>Markdown syntax styling</strong><br><img src="https://user-images.githubusercontent.com/7836623/34455900-697cbb6c-ed89-11e7-8c2b-29ec7dbcd703.png"/></p> + +❯ Added support for NeoVim UI terminal colors. (#63, @meck, af01167b) + +### Plugin Support + +#### Syntax + +❯ Added support for the [plasticboy/vim-markdown][plugin-plasticboy/vim-markdown] syntax plugin to match the style of the built-in markdown syntax styles. (#45 in PR #57, @VVVFO, 09921268) + + + + + +#### UI + +❯ Added support for the `PlugClean` command of the [junegunn/vim-plug][plugin-junegunn/vim-plug] plugin which used the `Ignore` group by default for deleted directory listings resulting in unreadable text when `cursorline` has been set. (#43 in PR #59, @dylnmc, e532b5d6) + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/30959403-53d9cd0a-a440-11e7-8c38-3045e280131a.gif"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/30959419-618876ea-a440-11e7-8895-6e9acfd8b830.gif"/></p> + +❯ Added basic support for [tpope/vim-fugitive][plugin-tpope/vim-fugitive]. (#76 in PR #77, @anhari, fa09c3b1) + +Filenames are now highlighted when using the `:Gstatus` command. + + + +## Improvements + +### Syntax + +❯ Added highlight support for legacy *diff* groups `diffAdded` and `diffRemoved` of the `git.vim` and `diff.vim` syntx definitions. (#66 in PR #67, @brandoniffert, 99e59e67) + +These groups are not in the [official vim documentation][vim-doc-diffAdd] but are still used by the syntax for example when run with `git commit --verbose`. + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/32219558-d906cf5c-be2e-11e7-98e7-d22583bac4f0.png"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/32219588-f00e0c4c-be2e-11e7-91e7-87bb28c48721.png"/></p> + +❯ Added highlighting support for Markdown *italic* and **bold** delimiter. (#90 in PR #92, 97c8aa24) + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/34452697-fd3d6502-ed45-11e7-9ba1-8e19e032c009.png"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/34452755-ee8046a0-ed46-11e7-8f3d-b9567995a9b4.png"/></p> + +❯ Added missing Markdown *italic* and **bold** groups. (#84 in PR #91, @lokesh-krishna @dylnmc, 63b46125) + +❯ Improved the highlighting for matching parens. (#75 and #71 in PR #78, @vincentzhezhang @cryptomaniac512 @dylnmc, 8eb7b2a6) + +The background color intensity under the cursor was too bright and the cursor no more visible causing the user to be distracted to focus on the matching bracket instead of the bracket at the cursor position. + +To optimally improve the highlighting `nord3` will now be used as background color for the matching element which doesn't conflict with the `cursorline` color and also stands out in order to see the matching element. + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/34409455-3370fada-ebca-11e7-9ed8-d83c3a9c5055.png"/></p> + +<p align="center"><strong>After with <code>cursorline</code> option</strong><br><img src="https://user-images.githubusercontent.com/7836623/34409567-d8c64bfc-ebca-11e7-919a-1a40cf146084.png"/></p> + +<p align="center"><strong>After without <code>cursorline</code> option</strong><br><img src="https://user-images.githubusercontent.com/7836623/34409570-dec9c1aa-ebca-11e7-8e68-32b79ec0d7c9.png"/></p> + +<p align="center"><img src="https://user-images.githubusercontent.com/7836623/34409581-eddcefc8-ebca-11e7-9ab7-29b80704d836.gif"/></p> + +## Bug Fixes + +❯ *TODO* keywords are now highlighted correctly for Neovim and gVim (#52 in PR #53, @dylnmc, 063620f0) + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/30737840-4c8014e0-9f88-11e7-9a26-7dea066e3316.png"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/30737858-5a7be150-9f88-11e7-9053-2aa75787a76d.png"/></p> + +❯ Fixed invisible inactive lightline bars (PR #73, @dylnmc, 788876b8) + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7635158/32986925-d6a79234-ccaa-11e7-9561-43daffa1722c.png"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7635158/32986927-e41880f4-ccaa-11e7-9444-316958ec74c1.png"/></p> + +❯ Fixed the `WildMenu` background color for current selection (tab completion) not being visible. (#64 in PR #80, @markand, 53fce0db) + +<p align="center"><strong>Before</strong><br><img src="https://user-images.githubusercontent.com/7836623/33609457-76d72fce-d9c8-11e7-9048-d2c6c7ed7800.gif"/></p> + +<p align="center"><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/33609464-806ee55e-d9c8-11e7-8020-58030141fac3.gif"/></p> + +## Tasks + +❯ Added the included [lightline theme to the official lightline repository][itchyny/lightline.vim-gh-257]. (#68 in [itchyny/lightline#257][itchyny/lightline.vim-gh-257], @lokesh-krishna, itchyny/lightline@e69081c1370a57647e05df21b60a4ef092c3ce91) + +### Documentation + +❯ Migrated to the MIT license to adapt to the migration of the main [Nord][nord-gh] project. Detailed information can be found in the [main task ticket][gh-55-arcticicestudio/nord]. (#69 in PR #70, fa55dc35) + # 0.6.0 -<details> - <summary>Version Details</summary> - <p> - Release Date: *2017-08-03* - <a href="https://github.com/arcticicestudio/nord-vim/milestone/8">Milestone</a> - <a href="https://github.com/arcticicestudio/nord-vim/projects/9">Project Board</a> - </p> -</details> + + [](https://github.com/arcticicestudio/nord-vim/projects/9) [](https://github.com/arcticicestudio/nord-vim/milestone/8) ## Features + ### Plugin Support + #### UI + ❯ Added basic support for [CtrlP][plugin-ctrlp]. (PR #33, @syedelec) * Matched characters are using the keyword color instead of the normal text color to make matched characters visible @@ -28,7 +178,9 @@ * Error signs are colorized using a `nord11` foreground instead of a red background with a white foreground ## Improvements + ### UI + ❯ The fold marker foreground has been adjusted to match the comment color instead of `nord1` which has been too dark causing them to be unreadable in bright environments. The background color has also been changed to `nord1` to differ from normal comments and the font style is now bold for better legibility. (#38 in PR #40, @dylnmc)  @@ -38,20 +190,27 @@  #### Neovim + ❯ Addded support for the Neovim specific `:CheckHealth` status highlight groups. (#31 in PR #42, @syedelec, Thanks to @dylnmc) <p align="center"><strong>Before</strong<br><img src="https://user-images.githubusercontent.com/7836623/28258007-150c94d6-6acf-11e7-92ee-c830e26067e4.png"/><br><strong>After</strong><br><img src="https://user-images.githubusercontent.com/7836623/28258017-21c124a8-6acf-11e7-9e93-dfacf0ad8b15.png"/></p> ## Bug Fixes + ### UI + ❯ Fixed unreadable text color on pending search result highlights. (#32 in PR #39, @syedelec) <p align="center">Before<br><img src="https://user-images.githubusercontent.com/7836623/28238074-20069028-694c-11e7-985f-f46f8c343ac5.png"/><br>After<br><img src="https://user-images.githubusercontent.com/7836623/28238077-297ccec4-694c-11e7-91cf-dcaae7aefb6d.png"/></p> # 0.5.0 -*2017-04-17* + + [](https://github.com/arcticicestudio/nord-vim/projects/8) [](https://github.com/arcticicestudio/nord-vim/milestone/7) + ## Improvements + ### Language Support + ❯ Implemented optimized styles for Ruby (@hahuang65, #29, 085c1337) - Symbols (`rubySymbol`) now have a bold font style - Block parameter list symbols (`rubyBlockParameterList`) are now colorized as keywords @@ -60,55 +219,75 @@ <p align="center"><img src="https://cloud.githubusercontent.com/assets/7836623/25083146/af02dd0a-2355-11e7-8adc-f53b0803a484.png"/></p> ## Bug Fixes + ### Documentation + ❯ Fixed a typo in the project description. (@arcticicestudio, #28, b2134029) # 0.4.0 -*2017-02-23* + + [](https://github.com/arcticicestudio/nord-vim/projects/7) [](https://github.com/arcticicestudio/nord-vim/milestone/6) + ## Features -### [Configurations][readme-configuration] + +### [Configurations][readme-config] + ❯ Added a configuration to enable [italic comments](https://github.com/arcticicestudio/nord-vim#italic-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`. +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 ``` + (@kepbod, #13 (PR #16), dc6149f4) ## Improvements + ### Plugin Support + ❯ The method/function signature live preview of the [`jedi-vim`](https://github.com/davidhalter/jedi-vim) plugin is now colorized correctly. (@mkalinski, #14, a5c3459a) <p align="center"><strong>Before</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/22618347/4857d88e-eada-11e6-9696-83a8886f5771.png"/><br><strong>After</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/22618354/63ddffde-eada-11e6-8a60-52a39642728e.png"/></p> ### Language Support + ❯ Implemented optimized styles for the Python syntax group `pythonEscape`. (@mkalinski, #22, 360a76ea)  ❯ Implemented optimized styles for the SQL syntax groups `sqlSpecial` which is now linked to the `sqlKeyword` group to colorize constants like `true`/`false` and `null` as keywords. (@mkalinski, #23, dcfb441e) ### Documentation + ❯ Added the new terminal emulator port project [Nord Hyper](https://github.com/arcticicestudio/nord-hyper) [](https://github.com/arcticicestudio/nord-hyper) # 0.3.0 -*2017-01-24* + + [](https://github.com/arcticicestudio/nord-vim/projects/6) [](https://github.com/arcticicestudio/nord-vim/milestone/5) + ## Improvements + ### Plugin Support + ❯ The [Nord lightline.vim][nord-lightline] UI plugin theme now includes better support for the [tmuxline.vim](https://github.com/edkolev/tmuxline.vim) plugin. Before this implementation text shown in the main segment of the tmuxline, generated via the `:Tmuxline lightline` command, has been colorized using `nord0` which resulted in unreadable text due to a `nord3` background. This has been fixed by using `nord5` as foreground color. (@scottwillmoore, #11, 4ea37f7e) <p align="center"><strong>Before</strong><br><img src="https://cloud.githubusercontent.com/assets/9512557/21741900/4f792f5e-d537-11e6-9e69-09ff11b60c4e.png"/><br><strong>After</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/21954034/15b87d1e-da47-11e6-9e70-a74aea14c378.png"/><br><strong>With unicode separators</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/21954058/7a7c5266-da47-11e6-8f1f-0203d5270c51.png"/><br><strong>Without specified configurations (tmuxline.vim autodetect)</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/21954072/931669e2-da47-11e6-8db3-cbdf9d6681f1.png"/></p> ## Bug Fixes + ### Documentation + ❯ Fixed a typo in the [README installation guide](https://github.com/arcticicestudio/nord-vim#via-pluginruntimepath-manager) for Vundle. (@kepbod, #10, 29145bbb) ❯ Fixed the banner of the [Nord iTerm2](https://github.com/arcticicestudio/nord-iterm2) port project showing the [Nord GNOME Terminal](https://github.com/arcticicestudio/nord-gnome-terminal) banner instead. (@shvetsovdm, #8 / [nord/#9](https://github.com/arcticicestudio/nord/issues/9), 7a447b40) # 0.2.0 -*2017-01-02* + + [](https://github.com/arcticicestudio/nord-vim/projects/5) [](https://github.com/arcticicestudio/nord-vim/milestone/4) ## Improvements + ❯ Characters under block cursors are now colored darker (`nord0`) while the block cursor is visible to achieve a optimal contrast and to avoid unreadability due to the same cursor- and foreground color (`nord4`). (@arcticicestudio / @scottwillmoore, #9, 30e1f7e3) <p align="center"><strong>Before</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/21586772/f08a56d2-d0d4-11e6-84e0-37e3021317ad.png"/><br><strong>After</strong><br><img src="https://cloud.githubusercontent.com/assets/7836623/21586785/23ef246c-d0d5-11e6-8573-2e0d8391186c.gif"/></p> @@ -120,20 +299,27 @@ This has been fixed by using `nord5` as foreground color. (@scottwillmoore, #11, # 0.1.2 *2017-01-01* + [](https://github.com/arcticicestudio/nord-vim/projects/4) [](https://github.com/arcticicestudio/nord-vim/milestone/3) + ## Bug Fixes + ❯ Fixed a bug where the `g:colors_name` variable has been unset caused by the `syntax reset` call due to the execution order. (@shuei72, #5, f8ffce24) # 0.1.1 -*2016-12-26* + + [](https://github.com/arcticicestudio/nord-vim/projects/3) [](https://github.com/arcticicestudio/nord-vim/milestone/2) ## Bug Fixes + ❯ Fixed wrong color variables (`*_term` to `*_gui`) for the `guisp` attribute of all `Spell*` highlighting groups which caused error logs while loading `vim`/`gvim`/MacVim. (@kamwitsta, #4, 4d642b9b) # 0.1.0 -*2016-12-25* + + [](https://github.com/arcticicestudio/nord-vim/projects/2) [](https://github.com/arcticicestudio/nord-vim/milestone/1) ## Features + Detailed information about features, supported plugins/languages and install instructions can be found in the [README](https://github.com/arcticicestudio/nord-vim/blob/develop/README.md#installation) and in the [project wiki](https://github.com/arcticicestudio/nord-vim/wiki). ❯ Implemented the main color theme file [`nord.vim`](https://github.com/arcticicestudio/nord-vim/blob/develop/colors/nord.vim). (@arcticicestudio, #1, e2832b9) @@ -148,11 +334,25 @@ Detailed information about features, supported plugins/languages and install ins <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-airline.png"/></p> -# 0.0.0 -*2016-12-25* -**Project Initialization** +# Project Initialization + + +[gh-55-arcticicestudio/nord]: https://github.com/arcticicestudio/nord/issues/55 +[gist-colors-in-terminals]: https://gist.github.com/XVilka/8346728 +[itchyny/lightline.vim-gh-257]: https://github.com/itchyny/lightline.vim/pull/257 +[lesscss-doc-fn-lighten]: http://lesscss.org/functions/#color-operations-lighten +[nord-gh]: https://github.com/arcticicestudio/nord +[nord-atom-syntax-pr-47]: https://github.com/arcticicestudio/nord-atom-syntax/pull/47 [nord-lightline]: https://github.com/arcticicestudio/nord-vim/blob/develop/autoload/lightline/colorscheme/nord.vim [plugin-ale]: https://github.com/w0rp/ale [plugin-ctrlp]: https://github.com/ctrlpvim/ctrlp.vim -[readme-configuration]: https://github.com/arcticicestudio/nord-vim#configuration +[plugin-junegunn/vim-plug]: https://github.com/junegunn/vim-plug +[plugin-plasticboy/vim-markdown]: https://github.com/plasticboy/vim-markdown +[plugin-tpope/vim-fugitive]: https://github.com/tpope/vim-fugitive +[readme-config]: https://github.com/arcticicestudio/nord-vim#configuration +[readme-config-comment-brightness]: https://github.com/arcticicestudio/nord-vim#comment-contrast +[readme-config-italic]: https://github.com/arcticicestudio/nord-vim#italic-support +[readme-config-uniform-diff-background]: https://github.com/arcticicestudio/nord-vim#uniform-diff-background +[readme-config-uniform-statusline-background]: https://github.com/arcticicestudio/nord-vim#uniform-status-lines +[vim-doc-diffAdd]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#hl-DiffAdd @@ -9,7 +9,7 @@ Based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color pa --- -Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with support for many third-party plugins and styles for [lightline.vim](https://github.com/itchyny/lightline.vim) and [vim-airline](https://github.com/vim-airline/vim-airline). +Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with support for many third-party plugins and styles for [lightline.vim][gh-itchyny/lightline.vim] and [vim-airline][gh-vim-airline/vim-airline]. <p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-javascript.png"/><br><blockquote>Font: <a href="https://adobe-fonts.github.io/source-code-pro">Source Code Pro</a> 20px</blockquote></p> @@ -19,7 +19,7 @@ Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with su - [Manual](#manual) - [Activation](#activation) - [Configuration](#configuration) - - [Italic Support](#italic) + - [Italic Support](#italic-support) - [Italic Comments](#italic-comments) - [Uniform Status Lines](#uniform-status-lines) - [Comment Contrast](#comment-contrast) @@ -33,7 +33,9 @@ Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with su - [Contribution](#contribution) ## Getting started + ### Installation + **NOTE**: Nord Vim in terminal mode **MUST** be used with the associated terminal emulator theme in order to work properly! Make sure to install one of the currently supported terminal themes listed below **BEFORE** installing Nord Vim. @@ -52,53 +54,67 @@ Make sure to install one of the currently supported terminal themes listed below [](https://github.com/arcticicestudio/nord-xresources) #### Via plugin/runtimepath manager -I recommend to use [`vim-plug`](https://github.com/junegunn/vim-plug). -Add Nord Vim to your `.vimrc` -```vim -Plug 'arcticicestudio/nord-vim' -``` -and install via `:PlugInstall`. -You can specify the `develop` branch to install the latest development version. -```vim -Plug 'arcticicestudio/nord-vim', { 'branch': 'develop' } -``` +Add Nord Vim to your `.vimrc` for your favorite manager. + +* [`vim-plug`][gh-junegunn/vim-plug] (recommended): + + ```vim + Plug 'arcticicestudio/nord-vim' + ``` + + and run `:PlugInstall`. + +* [`pathogen`](https://github.com/tpope/vim-pathogen): + + ```sh + cd ~/.vim/bundle + git clone git://github.com/arcticicestudio/nord-vim.git + ``` + +* [`Vundle`](https://github.com/VundleVim/Vundle.vim): + + ```vim + Plugin 'arcticicestudio/nord-vim' + ``` + + and run `:PluginInstall`. + +To install the latest development version [`vim-plug`][gh-junegunn/vim-plug] support to specifiy the `develop` branch: -A specific version can be installed via git tags. ```vim -Plug 'arcticicestudio/nord-vim', { 'tag': 'v0.6.0' } +Plug 'arcticicestudio/nord-vim', { 'branch': 'develop' } ``` -Of course it can be installed with any of your favorite tools: -[`pathogen`](https://github.com/tpope/vim-pathogen) -```sh -cd ~/.vim/bundle -git clone git://github.com/arcticicestudio/nord-vim.git -``` +A explicit version can be installed via Git tags: -[`Vundle`](https://github.com/VundleVim/Vundle.vim) -Add Nord Vim to your `.vimrc` ```vim -Plugin 'arcticicestudio/nord-vim' +Plug 'arcticicestudio/nord-vim', { 'tag': 'v0.7.0' } ``` -and install via `:PluginInstall`. #### Manual + [Download](https://github.com/arcticicestudio/nord-vim/releases/latest) the latest version or clone the repository and copy the [`nord.vim`](https://github.com/arcticicestudio/nord-vim/blob/develop/colors/nord.vim) theme file to your `~/.vim/colors` directory. ### Activation + Use Nord Vim as your default color theme by adding it to your `.vimrc` + ```vim colorscheme nord ``` + or change it on-the-fly by running `:colorscheme nord`. -[`vim-plug`](https://github.com/junegunn/vim-plug) also provides options to enable it on-demand for specific languages +[`vim-plug`][gh-junegunn/vim-plug] also provides options to enable it on-demand for specific languages: + ```vim " Activate Nord Vim when editing Java files Plug 'arcticicestudio/nord-vim', { 'for': 'java' } ``` -or on specific events. + +or on specific events: + ```vim " Activate Nord Vim when toggling the NERDTree Plug 'arcticicestudio/nord-vim', { 'on': 'NERDTreeToggle' } @@ -112,16 +128,18 @@ All options should be set **before** the [activation](#activation) command! **This option should only be enabled if your terminal emulator supports italics!** -Enables support for italic text. +Can be enabled to support italic text. Most terminals don't handle italics right so Nord disables italics for terminals by default while in GUI mode this option is enabled by default. -Italics for terminals can be enabled by setting the `g:nord_italic` to `1` to enforce displaying italics. +Set `g:nord_italic` to `1` to enforce displaying italics. ```vim 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/src/assets/scrot-config-italic-markdown.png"/></p> + ### Italic Comments **This option only takes effect if the option for [italic text support](#italic-support) has been enabled!** @@ -149,13 +167,11 @@ If the user desires the backgrounds to be a uniform color, `g:nord_uniform_statu let g:nord_uniform_status_lines = 1 ``` -<align="center"><strong>Default status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines-default.png"/><br><strong>Uniform status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines.png"/></p> +<p align="center"><strong>Default status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines-default.png"/><br><strong>Uniform status lines</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-uniform-status-lines.png"/></p> ### 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`! +**This option should only be enabled if your terminal supports 24bit true color (16 million colors) and requires the `termguicolors` option to be set is in `~/.vimrc` or 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`. @@ -164,10 +180,43 @@ variable to a number between `1` and `20`. let g:nord_comment_brightness = 12 ``` +<p align="center"><strong>Default and 15% increased</strong><br><img src="https://user-images.githubusercontent.com/7836623/30772939-a65c92b6-a066-11e7-92f2-2f7089fe7700.png"/><br><img src="https://user-images.githubusercontent.com/7836623/30772941-b85577d0-a066-11e7-9c64-b9dab6736034.png"/></p> + +<p align="center"><strong>Default and 12% increased</strong><br><img src="https://user-images.githubusercontent.com/7836623/30772949-ea459978-a066-11e7-8092-9e6522f9b7bf.png"/><br><img src="https://user-images.githubusercontent.com/7836623/30772950-eb8c2c84-a066-11e7-92d2-a64ac5f20521.png"/></p> + To adhere to the Nord style guide this option uses `nord3` by default. +This is a reference table if users like to use the same increased contrast values as provided by the [Nord Atom Syntax accessibility custom comment contrast theme setting][nord-atom-syntax-pr-47] which are calculated using the LESSCSS [`lighten`][lesscss-doc-fn-lighten] function. + +| Increased by | Calculated value | +| --- | --- | +| 1% | `#4e586d` | +| 2% | `#505b70` | +| 3% | `#525d73` | +| 4% | `#556076` | +| 5% | `#576279` | +| 6% | `#59647c` | +| 7% | `#5b677f` | +| 8% | `#5d6982` | +| 9% | `#5f6c85` | +| 10% | `#616e88` | +| 11% | `#63718b` | +| 12% | `#66738e` | +| 13% | `#687591` | +| 14% | `#6a7894` | +| 15% | `#6d7a96` | +| 16% | `#6f7d98` | +| 17% | `#72809a` | +| 18% | `#75829c` | +| 19% | `#78859e` | +| 20% | `#7b88a1` | + More information about true color and the support in various terminals can be found in [this gist][gist-true-color]. +<p align="center"><strong>Default and 15% increased</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-config-comment-contrast-java-default.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-config-comment-contrast-java-15-percent.png"/></p> + +<p align="center"><strong>Default and 12% increased</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-config-comment-contrast-js-default.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-config-comment-contrast-js-12-percent.png"/></p> + ### Uniform `diff` Background By default, Nord Vim provides colorful backgrounds when used in *diff* mode `vimdiff`/`vim -d`. @@ -182,9 +231,11 @@ let g:nord_uniform_diff_background = 1 </p> ## Plugin Support + Nord Vim provides support for many third-party language- and UI plugins. ### UI Plugins + <p align="center"><a href="https://github.com/itchyny/lightline.vim">lightline</a><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-lightline.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-lightline-vsplit.png"/></p> <p align="center"><a href="https://github.com/vim-airline/vim-airline">airline</a><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-airline.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-airline-vsplit.png"/></p> @@ -194,12 +245,15 @@ Nord Vim provides support for many third-party language- and UI plugins. <p align="center"><a href="https://github.com/scrooloose/nerdtree">NERDTree</a><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-plugin-support-ui-nerdtree.png"/></p> ### Language Plugins + #### JavaScript + [`vim-javascript`](https://github.com/pangloss/vim-javascript) Detailed descriptions for supported plugins can be found in the [project wiki](https://github.com/arcticicestudio/nord-vim/wiki). ## Languages + Nord Vim contains optimized styles to achieve a consistent and uniform coloring across languages. Detailed descriptions for supported languages can be found in the [project wiki](https://github.com/arcticicestudio/nord-vim/wiki) and in the [Plugin Support](#plugin-support) section. @@ -215,9 +269,11 @@ Detailed descriptions for supported languages can be found in the [project wiki] ![][scrot-lang-ruby] ## Development -[](https://github.com/arcticicestudio/nord-vim/blob/v0.6.0/CHANGELOG.md) [](http://nvie.com/posts/a-successful-git-branching-model) [](https://github.com/arcticicestudio/arcver) + +[](https://github.com/arcticicestudio/nord-vim/blob/v0.7.0/CHANGELOG.md) [](http://nvie.com/posts/a-successful-git-branching-model) [](https://github.com/arcticicestudio/arcver) ### Contribution + Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-vim/issues). <p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg" /></p> @@ -226,7 +282,12 @@ Please report issues/bugs, feature requests and suggestions for improvements to <p align="center"><a href="https://github.com/arcticicestudio/nord-vim/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p> +[gh-itchyny/lightline.vim]: https://github.com/itchyny/lightline.vim +[gh-junegunn/vim-plug]: https://github.com/junegunn/vim-plug +[gh-vim-airline/vim-airline]: https://github.com/vim-airline/vim-airline [gist-true-color]: https://gist.github.com/XVilka/8346728 +[lesscss-doc-fn-lighten]: http://lesscss.org/functions/#color-operations-lighten +[nord-atom-syntax-pr-47]: https://github.com/arcticicestudio/nord-atom-syntax/pull/47 [scrot-config-italic-comments]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-config-italic-comments.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 diff --git a/assets/scrot-config-comment-contrast-java-15-percent.png b/assets/scrot-config-comment-contrast-java-15-percent.png Binary files differnew file mode 100755 index 0000000..63c5266 --- /dev/null +++ b/assets/scrot-config-comment-contrast-java-15-percent.png diff --git a/assets/scrot-config-comment-contrast-java-default.png b/assets/scrot-config-comment-contrast-java-default.png Binary files differnew file mode 100755 index 0000000..d577b2a --- /dev/null +++ b/assets/scrot-config-comment-contrast-java-default.png diff --git a/assets/scrot-config-comment-contrast-js-12-percent.png b/assets/scrot-config-comment-contrast-js-12-percent.png Binary files differnew file mode 100755 index 0000000..0e5c196 --- /dev/null +++ b/assets/scrot-config-comment-contrast-js-12-percent.png diff --git a/assets/scrot-config-comment-contrast-js-default.png b/assets/scrot-config-comment-contrast-js-default.png Binary files differnew file mode 100755 index 0000000..efee604 --- /dev/null +++ b/assets/scrot-config-comment-contrast-js-default.png diff --git a/assets/scrot-config-italic-markdown.png b/assets/scrot-config-italic-markdown.png Binary files differnew file mode 100644 index 0000000..a1987ec --- /dev/null +++ b/assets/scrot-config-italic-markdown.png diff --git a/autoload/airline/themes/nord.vim b/autoload/airline/themes/nord.vim index 9920e9f..34a75e0 100755 --- a/autoload/airline/themes/nord.vim +++ b/autoload/airline/themes/nord.vim @@ -5,7 +5,7 @@ " Repository: https://github.com/arcticicestudio/nord-vim " License: MIT -let s:nord_vim_version="0.6.0" +let s:nord_vim_version="0.7.0" let g:airline#themes#nord#palette = {} let s:nord0_gui = "#2E3440" diff --git a/autoload/lightline/colorscheme/nord.vim b/autoload/lightline/colorscheme/nord.vim index 13879d7..c6a4d97 100755 --- a/autoload/lightline/colorscheme/nord.vim +++ b/autoload/lightline/colorscheme/nord.vim @@ -5,7 +5,7 @@ " Repository: https://github.com/arcticicestudio/nord-vim " License: MIT -let s:nord_vim_version="0.6.0" +let s:nord_vim_version="0.7.0" let s:p = {'normal': {}, 'inactive': {}, 'insert': {}, 'replace': {}, 'visual': {}, 'tabline': {}} let s:nord0 = ["#2E3440", "NONE"] diff --git a/colors/nord.vim b/colors/nord.vim index ee30dd3..4c06aa6 100755 --- a/colors/nord.vim +++ b/colors/nord.vim @@ -13,7 +13,7 @@ if version > 580 endif let g:colors_name = "nord" -let s:nord_vim_version="0.6.0" +let s:nord_vim_version="0.7.0" set background=dark let s:nord0_gui = "#2E3440" |
