diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 127 |
1 files changed, 94 insertions, 33 deletions
@@ -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 |