From 72cb5d702a276713cb28b1644a1daf67c8de3d4d Mon Sep 17 00:00:00 2001 From: Arctic Ice Studio Date: Tue, 21 May 2019 21:26:11 +0200 Subject: Nord Docs Transition All documentations and assets have been moved to the official Nord website and documentations (1,2). References: (1) nordtheme.com/ports/vim (2) arcticicestudio/nord-docs GH-158 --- README.md | 374 +++++++++----------------------------------------------------- 1 file changed, 55 insertions(+), 319 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 92ccf7c..67a87ff 100644 --- a/README.md +++ b/README.md @@ -1,350 +1,86 @@ -

+

-

+

-

An arctic, north-bluish clean and elegant Vim color theme.

+

-

Designed for a fluent and clear workflow.
-Based on the Nord color palette.

+

An arctic, north-bluish clean and elegant Vim color theme.

---- +

Designed for a fluent and clear workflow based on the Nord color palette.

-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]. +

-


Font: Source Code Pro 20px

+Build for Vim's terminal- and GUI mode with _true colors_ with support for many third-party syntax and UI plugins including bundled themes for[lightline.vim][gh-itchyny/lightline.vim] and [vim-airline][gh-vim-airline/vim-airline]. - - [Getting started](#getting-started) - - [Installation](#installation) - - [Via plugin/runtimepath manager](#via-pluginruntimepath-manager) - - [Manual](#manual) - - [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) - - [Uniform diff Background](#uniform-diff-background) - - [Line number background](#line-number-background) - - [Bold Vertical Split Line](#bold-vertical-split-line) - - [Plugin Support](#plugin-support) - - [UI Plugins](#ui-plugins) - - [Language Plugins](#language-plugins) - - [JavaScript](#javascript) - - [Languages](#languages) - - [Development](#development) - - [Contribution](#contribution) +## Getting Started -## Getting started +Visit the [official website][nord-home] to learn all about the [syntax highlighting][nord-home#syntax] features, details and elements of [UI and editor elements][nord-home#editor-details], the [various theme configurations][nord-home#configurations] and the [support for many plugins][nord-home#plugin-support]. -### Installation +Learn about the [installation and activation][nord-docs-home-install], how to [configure][nord-docs-home-config] and [customize][nord-docs-home-custom] the theme from the [official documentations][nord-docs-home]. -**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. +### Quick Start -[![Nord GNOME Terminal](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-gnome-terminal-banner.svg)](https://github.com/arcticicestudio/nord-gnome-terminal) -[![Nord Guake](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-guake-banner.svg)](https://github.com/arcticicestudio/nord-guake) -[![Nord Hyper](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-hyper-banner.svg)](https://github.com/arcticicestudio/nord-hyper) -[![Nord iTerm2](https://cdn.rawgit.com/arcticicestudio/nord/0971858f496823fd916f3368961f16ef2c7aad1e/src/assets/nord-iterm2-banner.svg)](https://github.com/arcticicestudio/nord-iterm2) -[![Nord Konsole](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-konsole-banner.svg)](https://github.com/arcticicestudio/nord-konsole) -[![Nord Mintty](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-mintty-banner.svg)](https://github.com/arcticicestudio/nord-mintty) -[![Nord PuTTY](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-putty-banner.svg)](https://github.com/arcticicestudio/nord-putty) -[![Nord Terminal.app](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-terminal-app-banner.svg)](https://github.com/arcticicestudio/nord-terminal-app) -[![Nord Terminator](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-terminator-banner.svg)](https://github.com/arcticicestudio/nord-terminator) -[![Nord Tilix](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-tilix-banner.svg)](https://github.com/arcticicestudio/nord-tilix) -[![Nord Termite](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-termite-banner.svg)](https://github.com/arcticicestudio/nord-termite) -[![Nord XFCE Terminal](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-xfce-terminal-banner.svg)](https://github.com/arcticicestudio/nord-xfce-terminal) -[![Nord Xresources](https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/nord-xresources-banner.svg)](https://github.com/arcticicestudio/nord-xresources) +Thanks to existing plugin/_runtimepath_ managers for Vim, Nord Vim can be installed for all platforms and the various variants/forks of Vim in a uniform way within a few lines of codes. The recommended manager is [vim-plug][gh-junegunn/vim-plug], but any other manager like [pathogen][gh-tpope/vim-pathogen] or [Vundle][gh-vundlevim/vundle.vim] can also be used. -#### Via plugin/runtimepath manager +To automatically download and activate Nord Vim, follow the install instructions for [vim-plug][gh-junegunn/vim-plug] and -Add Nord Vim to your `.vimrc` for your favorite manager. +1. add `Plug 'arcticicestudio/nord-vim'` to your [`vimrc`][vimhelp-vimrc] within _vim-plug_'s plugin loading function +2. run the `:PlugInstall` command in Vim +3. activate the theme by adding `colorscheme nord` to the [vimrc][vimhelp-vimrc] or change it on-the-fly by running `:colorscheme nord` -* [`vim-plug`][gh-junegunn/vim-plug] (recommended): +

- ```vim - Plug 'arcticicestudio/nord-vim' - ``` +See the Nord Vim's documentation for [more installation options][nord-docs-home-install] and how to [set it up manually][nord-docs-home-install#manual]. - and run `:PlugInstall`. +## Features -* [`pathogen`](https://github.com/tpope/vim-pathogen): +

A unified UI and editor syntax element design provides a clutter-free and fluidly merging appearance.

- ```sh - cd ~/.vim/bundle - git clone git://github.com/arcticicestudio/nord-vim.git - ``` +

Small details with unobtrusive styles for popular and common code editor features like search result marker and brace matching — designed to get out of your way with a visually attractive appearance.

-* [`Vundle`](https://github.com/VundleVim/Vundle.vim): +

Support for a wide range of programming languages — from bundled plugins up to many popular syntax and UI third-party plugins.

- ```vim - Plugin 'arcticicestudio/nord-vim' - ``` +## Contributing - and run `:PluginInstall`. +Nord is an open source project and we love to receive contributions from the [community][nord-comm]! -To install the latest development version [`vim-plug`][gh-junegunn/vim-plug] support to specifiy the `develop` branch: +There are many ways to contribute, from [writing- and improving documentation and tutorials][nord-contrib-guide-docs], [reporting bugs][nord-contrib-guide-bugs], [submitting enhancement suggestions][nord-contrib-guide-enhance] that can be added to Nord by [submitting pull requests][nord-contrib-guide-pr]. -```vim -Plug 'arcticicestudio/nord-vim', { 'branch': 'develop' } -``` +Please take a moment to read Nord's full [contributing guide][nord-contrib-guide] to learn about the development process, the project's used [styleguides][nord-contrib-guide-styles], [branch organization][nord-contrib-guide-branching] and [versioning][nord-contrib-guide-versioning] model. -A explicit version can be installed via Git tags: +The guide also includes information about [minimal, complete, and verifiable examples][nord-contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][nord-contrib-guide-impr-issues] and [giving feedback on issues and pull requests][nord-contrib-guide-feedback]. -```vim -Plug 'arcticicestudio/nord-vim', { 'tag': 'v0.11.0' } -``` +

-#### Manual +

Copyright © 2016-present Arctic Ice Studio and Sven Greb

-[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`][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: - -```vim -" Activate Nord Vim when toggling the NERDTree -Plug 'arcticicestudio/nord-vim', { 'on': 'NERDTreeToggle' } -``` - -## Configuration - -All options should be set **before** the [activation](#activation) command! - -### Italic Support - -**This option should only be enabled if your terminal emulator supports italics!** - -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. - -Set `g:nord_italic` to `1` to enforce displaying italics. - -```vim -let g:nord_italic = 1 -``` - -

Italic formatting in Markdown

- -### 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 -``` - -

Underlined Text

- -### Italic Comments - -**This option only takes effect if the option for [italic text support](#italic-support) has been enabled!** - -Enable to italicize 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 -``` - -![][scrot-config-italic-comments] - -### Uniform Status Lines - -Enables uniform activate- and inactive status lines using `nord3` as background. - -By default, Nord Vim uses a slightly brighter background for the current split buffer. This is designed to draw attention to the currently active buffer without being distracting. - -If the user desires the backgrounds to be a uniform color, `g:nord_uniform_status_lines` can be set to `1`: - -```vim -let g:nord_uniform_status_lines = 1 -``` - -

Default status lines

Uniform status lines

- -### Comment Contrast - -**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`. - -```vim -let g:nord_comment_brightness = 12 -``` - -

Default and 15% increased

- -

Default and 12% increased

- -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]. - -

Default and 15% increased

- -

Default and 12% increased

- -### Uniform `diff` Background - -By default, Nord Vim provides colorful backgrounds when used in *diff* mode `vimdiff`/`vim -d`. - -This can be changed to `nord1` as uniform *diff* background color by setting the `g:nord_uniform_diff_background` variable to `1`. - -```vim -let g:nord_uniform_diff_background = 1 -``` - -

Colorful backgrounds (default)

Uniform diff background
-

- -### Line number background - -Enables background for the line number of the current line. - -```vim -let g:nord_cursor_line_number_background = 1 -``` - -

No background (default)

Enabled background
-

- -### Bold Vertical Split Line - -Enables a bolder vertical split line by using `nord1` as background. - -```viml -let g:nord_bold_vertical_split_line = 1 -``` - -To change the separator character used to display the vertical line please see the documentation about Vim's [`fillchars`][vdoc-fillchars] variable: `:help fillchars` - -

With base editor background (default)

- -

With enabled bold nord1 background

- -## Plugin Support - -Nord Vim provides support for many third-party language- and UI plugins. - -### UI Plugins - -

With custom separators and components using lightline's advanced configurations

- -

lightline with default format and components

- -

airline

- -

GitGutter

- -

NERDTree

- -### 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. - -![][scrot-lang-c] -![][scrot-lang-css] -![][scrot-lang-html] -![][scrot-lang-java] -![][scrot-lang-javascript] -![][scrot-lang-json] -![][scrot-lang-markdown] -![][scrot-lang-php] -![][scrot-lang-python] -![][scrot-lang-ruby] - -## Development - -[![](https://img.shields.io/badge/Changelog-0.11.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/nord-vim/blob/v0.11.0/CHANGELOG.md#0110) [![](https://img.shields.io/badge/Workflow-gitflow--branching--model-81A1C1.svg?style=flat-square)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-81A1C1.svg?style=flat-square)](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). - -

- -

Copyright © 2016-present Arctic Ice Studio

- -

+

[gh-itchyny/lightline.vim]: https://github.com/itchyny/lightline.vim [gh-junegunn/vim-plug]: https://github.com/junegunn/vim-plug +[gh-tpope/vim-pathogen]: https://github.com/tpope/vim-pathogen [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 -[scrot-lang-html]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-html.png -[scrot-lang-java]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-java.png -[scrot-lang-javascript]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-javascript.png -[scrot-lang-json]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-json.png -[scrot-lang-markdown]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-markdown.png -[scrot-lang-php]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-php.png -[scrot-lang-python]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-python.png -[scrot-lang-ruby]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-ruby.png -[scrot-readme-default-profile]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-readme-default-profile.png -[scrot-readme-lazy-profile-change]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-readme-lazy-profile-change.png -[vdoc-fillchars]: http://vimdoc.sourceforge.net/htmldoc/options.html#'fillchars' +[gh-vundlevim/vundle.vim]: https://github.com/tpope/vim-pathogen +[nord-comm]: https://www.nordtheme.com/community +[nord-contrib-guide-branching]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#branch-organization +[nord-contrib-guide-bugs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#bug-reports +[nord-contrib-guide-docs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#documentations +[nord-contrib-guide-enhance]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#enhancement-suggestions +[nord-contrib-guide-feedback]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests +[nord-contrib-guide-impr-issues]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#improve-issues +[nord-contrib-guide-mcve]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#mcve +[nord-contrib-guide-pr]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#pull-requests +[nord-contrib-guide-styles]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#styleguides +[nord-contrib-guide-versioning]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#versioning +[nord-contrib-guide]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md +[nord-docs-home-config]: https://www.nordtheme.com/docs/ports/vim/configuration +[nord-docs-home-custom]: https://www.nordtheme.com/docs/ports/vim/customization +[nord-docs-home-install]: https://www.nordtheme.com/docs/ports/vim/installation +[nord-docs-home-install#manual]: https://www.nordtheme.com/docs/ports/vim/installation#manual +[nord-docs-home]: https://www.nordtheme.com/docs/ports/vim +[nord-home]: https://www.nordtheme.com/ports/vim +[nord-home#configurations]: https://www.nordtheme.com/ports/vim#configurations +[nord-home#editor-details]: https://www.nordtheme.com/ports/vim#editor-details +[nord-home#plugin-support]: https://www.nordtheme.com/ports/vim#plugin-support +[nord-home#syntax]: https://www.nordtheme.com/ports/vim#syntax +[vimhelp-vimrc]: https://vimhelp.org/starting.txt.html#vimrc -- cgit v1.2.3-70-g09d2