vim/nordtheme.vim
1
0
Fork 0
mirror of https://github.com/nordtheme/vim.git synced 2026-09-10 07:36:23 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
nordtheme.vim/readme.md
Sven Greb f13f5dfbb7
Adapt remaining arcticicestudio "fade-out" changes (#342) 
With the retirement of the "Arctic Ice Studio" personal & Nord project
brand [1] various migrations to the `svengreb` GitHub account [2] of
other projects were also completed within the last weeks. There are also
changes in Nord projects like `nordtheme/web` that other projects
depended on and can now be adapted as well.
Therefore all Nord projects must adapt these changes which includes...

- the migration and repository name change of
  `arcticicestudio/nord-docs`[2] - all references must be updated.
- the migration of the `arcticicestudio/styleguide-git` repository to
  the `svengreb` "real-in-person" identity [3] - all references and
  used npm packages must be updated.
- the migration of the `arcticicestudio/styleguide-javascript`
  repository to the `svengreb` "real-in-person" identity [4] - all
  references and used npm packages must be updated.
- the migration of the `arcticicestudio/styleguide-markdown` repository
  to the `svengreb` "real-in-person" identity [5] - all references and
  used npm packages must be updated.

[1]: https://github.com/orgs/nordtheme/discussions/183#retire-arctic-ice-studio-as-nord-brand
[2]: https://github.com/nordtheme/web/issues/241
[3]: https://github.com/svengreb/styleguide-git/issues/12
[4]: https://github.com/svengreb/styleguide-javascript/issues/88
[5]: https://github.com/svengreb/styleguide-markdown/issues/63

GH-341
2023-05-03 22:43:25 +02:00

153 lines
10 KiB
Markdown
Raw Blame History

<p align="center">
<a href="https://www.nordtheme.com/ports/vim" target="_blank">
<picture>
<source srcset="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/repository-hero.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/repository-hero.svg?sanitize=true" width="100%" />
</picture>
</a>
</p>
<p align="center">
<a href="https://github.com/nordtheme/vim/releases/latest" target="_blank">
<img src="https://img.shields.io/github/release/nordtheme/vim.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/>
</a>
<a href="https://www.nordtheme.com/docs/ports/vim" target="_blank">
<img src="https://img.shields.io/github/release/nordtheme/vim.svg?style=flat-square&label=Docs&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiI%2BCiAgICA8cGF0aCBmaWxsPSIjZDhkZWU5IiBkPSJNMTMuNzQ2IDIuODEzYS42Ny42NyAwIDAgMC0uNTU5LS4xMzNMOCAzLjg0OGwtNS4xODgtMS4xOGEuNjY5LjY2OSAwIDAgMC0uNTcuMTMzLjY3Ny42NzcgMCAwIDAtLjI0Mi41MzF2OC4xMzNjLS4wMDguMzIuMjEuNTk4LjUyLjY2OGw1LjMzMiAxLjE5OWguMjk2bDUuMzMyLTEuMmEuNjY4LjY2OCAwIDAgMCAuNTItLjY2N1YzLjMzMmEuNjU5LjY1OSAwIDAgMC0uMjU0LS41MnpNMy4zMzIgNC4xNjhsNCAuODk4djYuNzY2bC00LS44OTh6bTkuMzM2IDYuNzY2bC00IC44OThWNS4wNjZsNC0uODk4em0wIDAiLz4KPC9zdmc%2BCg%3D%3D"/>
</a>
<a href="https://github.com/nordtheme/vim/blob/main/changelog.md#050" target="_blank">
<img src="https://img.shields.io/github/release/nordtheme/vim.svg?style=flat-square&label=Changelog&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/>
</a>
</p>
<p align="center">
<a href="https://github.com/svengreb/styleguide-javascript/releases/latest" target="_blank">
<img src="https://img.shields.io/github/release/svengreb/styleguide-javascript.svg?style=flat-square&label=JavaScript%20Style%20Guide&logoColor=eceff4&colorA=4c566a&colorB=88c0d0&logo=javascript"/>
</a>
<a href="https://github.com/svengreb/styleguide-markdown/releases/latest" target="_blank">
<img src="https://img.shields.io/github/release/svengreb/styleguide-markdown.svg?style=flat-square&label=Markdown%20Style%20Guide&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzOSIgaGVpZ2h0PSIzOSIgdmlld0JveD0iMCAwIDM5IDM5Ij48cGF0aCBmaWxsPSJub25lIiBzdHJva2U9IiNEOERFRTkiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNMS41IDEuNWgzNnYzNmgtMzZ6Ii8%2BPHBhdGggZmlsbD0iI0Q4REVFOSIgZD0iTTIwLjY4MyAyNS42NTVsNS44NzItMTMuNDhoLjU2Nmw1Ljg3MyAxMy40OGgtMS45OTZsLTQuMTU5LTEwLjA1Ni00LjE2MSAxMC4wNTZoLTEuOTk1em0tMi42OTYgMGwtMTMuNDgtNS44NzJ2LS41NjZsMTMuNDgtNS44NzJ2MS45OTVMNy45MzEgMTkuNWwxMC4wNTYgNC4xNnoiLz48L3N2Zz4%3D"/>
</a>
<a href="https://github.com/svengreb/styleguide-git/releases/latest" target="_blank">
<img src="https://img.shields.io/github/release/svengreb/styleguide-git.svg?style=flat-square&label=Git%20Style%20Guide&logoColor=eceff4&colorA=4c566a&colorB=88c0d0&logo=git"/>
</a>
</p>
<p align="center">An arctic, north-bluish clean and elegant <a href="https://www.vim.org">Vim</a> color theme.</p>
<p align="center">Designed for a fluent and clear workflow based on the <a href="https://www.nordtheme.com">Nord</a> color palette.</p>
<p align="center">
<a href="https://www.nordtheme.com/ports/vim" target="_blank">
<picture>
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/overview-go.png"/>
</picture>
</a>
</p>
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][1] and [vim-airline][4].
## Getting Started
Visit the [official website][23] to learn all about the [syntax highlighting][27] features, details and elements of [UI and editor elements][25], the [various theme configurations][24] and the [support for many plugins][26].
Learn about the [installation and activation][20], how to [configure][18] and [customize][19] the theme from the [official documentations][22].
### Quick Start
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][2], but any other manager like [pathogen][3] or [Vundle][3] can also be used.
To automatically download and activate Nord Vim, follow the install instructions for [vim-plug][2] and
1. add `Plug 'nordtheme/vim'` to your [`vimrc`][28] 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][28] or change it on-the-fly by running `:colorscheme nord`
<p align="center">
<picture>
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/installation-vim-plug.png"/>
</picture>
</p>
See the Nord Vim's documentation for [more installation options][20] and how to [set it up manually][21].
## Features
<p align="center">
<strong>A unified UI and editor syntax element design provides a clutter-free and fluidly merging appearance.</strong><br />
<picture>
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/overview-go-nerdtree.png"/>
</picture>
</p>
<p align="center">
<strong>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.</strong><br />
<picture>
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/editor-search-highlighting.png"/>
</picture>
</p>
<p align="center">
<strong>Support for a wide range of programming languages — from bundled plugins up to many popular syntax and UI third-party plugins.</strong><br />
<picture>
<img src="https://raw.githubusercontent.com/nordtheme/web/main/assets/images/ports/vim/syntax-javascript-react-hook.png"/>
</picture>
</p>
## Contributing
Nord is an open source project and we love to receive contributions from the [community][6]!
There are many ways to contribute, from [writing- and improving documentation and tutorials][9], [reporting bugs][8], [submitting enhancement suggestions][10] that can be added to Nord by [submitting pull requests][14].
Please take a moment to read Nord's full [contributing guide][17] to learn about the development process, the project's used [styleguides][15], [branch organization][7] and [versioning][16] model.
The guide also includes information about [minimal, complete, and verifiable examples][13] and other ways to contribute to the project like [improving existing issues][12] and [giving feedback on issues and pull requests][11].
<p align="center">
<picture>
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" />
<source srcset="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/light/spaced.svg?sanitize=true" width="100%" media="(prefers-color-scheme: dark)" />
<img src="https://raw.githubusercontent.com/nordtheme/assets/main/static/images/elements/separators/iceberg/footer/dark/spaced.svg?sanitize=true" width="100%" />
</picture>
</p>
<p align="center">
Copyright &copy; 2016-present <a href="https://www.svengreb.de" target="_blank">Sven Greb</a>
</p>
<p align="center">
<a href="https://github.com/nordtheme/vim/blob/main/license" target="_blank">
<img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/>
</a>
<a href="https://www.svengreb.de">
<img src="https://img.shields.io/static/v1.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAABMklEQVQ4jcWQvUoDQRRGz52s5IfVIiDWPkGKFFaCIVaGdIagjcFAwICFb7DvIK6QQlNpY2UQLMQVBbEQ0SewFkGbKCQmOzaTJay7/lR+zTAf9xwuF/47Mv45rdezqWEq72v/RWZnHgqOMwDwHMfSj085JSqb6Pu38we7r18E3nqzhmYbsE11rxKsAvhDfQiSM30XYbOw57YDwfnaRl6U3ABWaMNn806H+oGPzBX3d+4UgChZiYBHYBgGsBLoKoAyhR0x9G20Zmpc4P1ZoMQDcwMNclFrdhBKv6M5WWi7ZQGtjEUn35IV4OwnVjSX/WGmKqCDDUa5rmyle3bvGFiMg3WGUsF1u0EXHoqTRMGRgkAy2eugKZrqijRLYThWANBpNDL2h3UE0J0YLJdbrfe42f/NJ0wqY7/KcXKPAAAAAElFTkSuQmCC&label=lovely%20crafted%20in&message=Germany&colorA=4c566a&colorB=88c0d0"/>
</a>
</p>
[1]: https://github.com/itchyny/lightline.vim
[2]: https://github.com/junegunn/vim-plug
[3]: https://github.com/tpope/vim-pathogen
[4]: https://github.com/vim-airline/vim-airline
[6]: https://www.nordtheme.com/community
[7]: https://github.com/nordtheme/.github/blob/main/contributing.md#branch-organization
[8]: https://github.com/nordtheme/.github/blob/main/contributing.md#bug-reports
[9]: https://github.com/nordtheme/.github/blob/main/contributing.md#documentations
[10]: https://github.com/nordtheme/.github/blob/main/contributing.md#enhancement-suggestions
[11]: https://github.com/nordtheme/.github/blob/main/contributing.md#feedback
[12]: https://github.com/nordtheme/.github/blob/main/contributing.md#improve-issues
[13]: https://github.com/nordtheme/.github/blob/main/contributing.md#mcve
[14]: https://github.com/nordtheme/.github/blob/main/contributing.md#pull-requests
[15]: https://github.com/nordtheme/.github/blob/main/contributing.md#style-guides
[16]: https://github.com/nordtheme/.github/blob/main/contributing.md#versioning
[17]: https://github.com/nordtheme/.github/blob/main/contributing.md
[18]: https://www.nordtheme.com/docs/ports/vim/configuration
[19]: https://www.nordtheme.com/docs/ports/vim/customization
[20]: https://www.nordtheme.com/docs/ports/vim/installation
[21]: https://www.nordtheme.com/docs/ports/vim/installation#manual
[22]: https://www.nordtheme.com/docs/ports/vim
[23]: https://www.nordtheme.com/ports/vim
[24]: https://www.nordtheme.com/ports/vim#configurations
[25]: https://www.nordtheme.com/ports/vim#editor-details
[26]: https://www.nordtheme.com/ports/vim#plugin-support
[27]: https://www.nordtheme.com/ports/vim#syntax
[28]: https://vimhelp.org/starting.txt.html#vimrc
Reference in a new issue View git blame Copy permalink