mirror of
https://github.com/joshdick/onedark.vim.git
synced 2025-11-08 11:03:49 -05:00
chore(build): Build/linting infrastructure updates. (#276)
* Move npm/linting config files to root directory * Apply prettier/eslint autofixes * Update CONTRIBUTING.md
This commit is contained in:
Josh Dick
84
README.md
84
README.md
@@ -10,19 +10,19 @@ A dark Vim/Neovim color scheme for the GUI and 16/256/true-color terminals, base
|
||||
|
||||
onedark.vim includes support for the following Vim and Neovim plugins:
|
||||
|
||||
* [airblade/vim-gitgutter](https://github.com/airblade/vim-gitgutter)
|
||||
* [dense-analysis/ale](https://github.com/dense-analysis/ale)
|
||||
* [easymotion/vim-easymotion](https://github.com/easymotion/vim-easymotion)
|
||||
* [itchyny/lightline.vim](https://github.com/itchyny/lightline.vim)
|
||||
* [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
|
||||
* [mhinz/vim-signify](https://github.com/mhinz/vim-signify)
|
||||
* [neoclide/coc.nvim](https://github.com/neoclide/coc.nvim)
|
||||
* [neomake/neomake](https://github.com/neomake/neomake)
|
||||
* [Neovim LSP](https://neovim.io/doc/user/lsp.html)
|
||||
* [plasticboy/vim-markdown](https://github.com/plasticboy/vim-markdown)
|
||||
* [prabirshrestha/vim-lsp](https://github.com/prabirshrestha/vim-lsp)
|
||||
* [tpope/vim-fugitive](https://github.com/tpope/vim-fugitive)
|
||||
* [vim-airline/vim-airline](https://github.com/vim-airline/vim-airline)
|
||||
- [airblade/vim-gitgutter](https://github.com/airblade/vim-gitgutter)
|
||||
- [dense-analysis/ale](https://github.com/dense-analysis/ale)
|
||||
- [easymotion/vim-easymotion](https://github.com/easymotion/vim-easymotion)
|
||||
- [itchyny/lightline.vim](https://github.com/itchyny/lightline.vim)
|
||||
- [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
|
||||
- [mhinz/vim-signify](https://github.com/mhinz/vim-signify)
|
||||
- [neoclide/coc.nvim](https://github.com/neoclide/coc.nvim)
|
||||
- [neomake/neomake](https://github.com/neomake/neomake)
|
||||
- [Neovim LSP](https://neovim.io/doc/user/lsp.html)
|
||||
- [plasticboy/vim-markdown](https://github.com/plasticboy/vim-markdown)
|
||||
- [prabirshrestha/vim-lsp](https://github.com/prabirshrestha/vim-lsp)
|
||||
- [tpope/vim-fugitive](https://github.com/tpope/vim-fugitive)
|
||||
- [vim-airline/vim-airline](https://github.com/vim-airline/vim-airline)
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -77,11 +77,11 @@ onedark.vim includes support for the following Vim and Neovim plugins:
|
||||
|
||||
**Note:** All options should be set **before** the `colorscheme onedark` line in your `~/.vimrc`.
|
||||
|
||||
* `g:onedark_hide_endofbuffer`: Set to `1` if you want to hide end-of-buffer filler lines (~) for a cleaner look; `0` otherwise (the default).
|
||||
- `g:onedark_hide_endofbuffer`: Set to `1` if you want to hide end-of-buffer filler lines (~) for a cleaner look; `0` otherwise (the default).
|
||||
|
||||
* `g:onedark_termcolors` **(see [Troubleshooting](#troubleshooting) (below) for more information about this option)**: Set to `256` for 256-color terminals (the default), or set to `16` to use your terminal emulator's native 16 colors.
|
||||
- `g:onedark_termcolors` **(see [Troubleshooting](#troubleshooting) (below) for more information about this option)**: Set to `256` for 256-color terminals (the default), or set to `16` to use your terminal emulator's native 16 colors.
|
||||
|
||||
* `g:onedark_terminal_italics`: Set to `1` if your terminal emulator supports italics; `0` otherwise (the default).
|
||||
- `g:onedark_terminal_italics`: Set to `1` if your terminal emulator supports italics; `0` otherwise (the default).
|
||||
|
||||
## lightline.vim Colorscheme
|
||||
|
||||
@@ -91,8 +91,8 @@ This repository includes a companion [lightline.vim](https://github.com/itchyny/
|
||||
|
||||
The lightline.vim colorscheme:
|
||||
|
||||
* Depends on `autoload/onedark.vim` for its colors, and must therefore be used in conjunction with it.
|
||||
* Works with both color modes available in onedark.vim (16 or 256 colors), as specified in the configuration for onedark.vim.
|
||||
- Depends on `autoload/onedark.vim` for its colors, and must therefore be used in conjunction with it.
|
||||
- Works with both color modes available in onedark.vim (16 or 256 colors), as specified in the configuration for onedark.vim.
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -114,9 +114,9 @@ This repository includes a companion [vim-airline](https://github.com/vim-airlin
|
||||
|
||||
The vim-airline theme:
|
||||
|
||||
* Depends on `autoload/onedark.vim` for its colors, and must therefore be used in conjunction with it.
|
||||
* Works with both color modes available in onedark.vim (16 or 256 colors), as specified in the configuration for onedark.vim.
|
||||
* Is based on vim-airline's ["tomorrow" theme](https://github.com/vim-airline/vim-airline-themes/blob/master/autoload/airline/themes/tomorrow.vim).
|
||||
- Depends on `autoload/onedark.vim` for its colors, and must therefore be used in conjunction with it.
|
||||
- Works with both color modes available in onedark.vim (16 or 256 colors), as specified in the configuration for onedark.vim.
|
||||
- Is based on vim-airline's ["tomorrow" theme](https://github.com/vim-airline/vim-airline-themes/blob/master/autoload/airline/themes/tomorrow.vim).
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -146,23 +146,23 @@ However, you can use the `g:onedark_termcolors` option to control onedark.vim's
|
||||
|
||||
**When Vim/Neovim are configured to use 24-bit color, the `g:onedark_termcolors` option is ignored. However, `g:onedark_termcolors` can still coexist with 24-bit color configuration.** For instance, when tmux 2.1 or earlier and/or older Vim/Neovim versions that don't support 24-bit color are used, the `g:onedark_termcolors` option will take effect.
|
||||
|
||||
* **256-color mode** is enabled by default with no additional configuration, but colors are less accurate since they are approximated using a 256-color palette. The background color will appear darker than in the preview image, and most other colors will appear brighter than in the preview image. If you don't want to change your terminal's color palette as described in the 16-color mode section below, and your terminal doesn't support 24-bit color, 256-color mode is your only option.
|
||||
- **256-color mode** is enabled by default with no additional configuration, but colors are less accurate since they are approximated using a 256-color palette. The background color will appear darker than in the preview image, and most other colors will appear brighter than in the preview image. If you don't want to change your terminal's color palette as described in the 16-color mode section below, and your terminal doesn't support 24-bit color, 256-color mode is your only option.
|
||||
|
||||
Although 256-color mode is enabled by default (when not using 24-bit color as described above), you can explicitly enable it by adding the following line to your `~/.vimrc`:
|
||||
Although 256-color mode is enabled by default (when not using 24-bit color as described above), you can explicitly enable it by adding the following line to your `~/.vimrc`:
|
||||
|
||||
```vim
|
||||
let g:onedark_termcolors=256
|
||||
```
|
||||
```vim
|
||||
let g:onedark_termcolors=256
|
||||
```
|
||||
|
||||
* **16-color mode** is the preferred option, since its colors are more accurate than those of 256-color mode. However, you'll need to set your terminal emulator's color palette to this color scheme's custom 16-color palette, since 16-color mode will cause the color scheme to use your terminal emulator's native 16 colors. If you don't use the custom 16-color palette in your terminal emulator when 16-color mode is enabled, onedark.vim's colors will not display correctly in Vim.
|
||||
- **16-color mode** is the preferred option, since its colors are more accurate than those of 256-color mode. However, you'll need to set your terminal emulator's color palette to this color scheme's custom 16-color palette, since 16-color mode will cause the color scheme to use your terminal emulator's native 16 colors. If you don't use the custom 16-color palette in your terminal emulator when 16-color mode is enabled, onedark.vim's colors will not display correctly in Vim.
|
||||
|
||||
The canonical version of the 16-color palette is an [Xresources](https://en.wikipedia.org/wiki/X_resources) file located in this repository at `term/One Dark.Xresources`. Color schemes for various terminal emulators are also provided in `term/`. (The [iTerm2](https://iterm2.com/) color scheme works with iTerm2 versions 2.9.x and later.) You should be able to easily convert the Xresources color scheme for use with your terminal emulator of choice either by hand, or automatically by using [termcolors](https://github.com/stayradiated/termcolors).
|
||||
The canonical version of the 16-color palette is an [Xresources](https://en.wikipedia.org/wiki/X_resources) file located in this repository at `term/One Dark.Xresources`. Color schemes for various terminal emulators are also provided in `term/`. (The [iTerm2](https://iterm2.com/) color scheme works with iTerm2 versions 2.9.x and later.) You should be able to easily convert the Xresources color scheme for use with your terminal emulator of choice either by hand, or automatically by using [termcolors](https://github.com/stayradiated/termcolors).
|
||||
|
||||
Assuming your terminal emulator is configured to use the custom 16-color palette as described above, add the following line to your `~/.vimrc` to enable 16-color mode:
|
||||
Assuming your terminal emulator is configured to use the custom 16-color palette as described above, add the following line to your `~/.vimrc` to enable 16-color mode:
|
||||
|
||||
```vim
|
||||
let g:onedark_termcolors=16
|
||||
```
|
||||
```vim
|
||||
let g:onedark_termcolors=16
|
||||
```
|
||||
|
||||
### Why do all comments look like they're highlighted?
|
||||
|
||||
@@ -254,18 +254,18 @@ Several other themes and projects have reused code and/or colors from this proje
|
||||
|
||||
If onedark.vim isn't meeting your needs, try one of its relatives!
|
||||
|
||||
* [drewtempelmeyer/palenight.vim](https://github.com/drewtempelmeyer/palenight.vim)
|
||||
* [KeitaNakamura/neodark.vim](https://github.com/KeitaNakamura/neodark.vim)
|
||||
* [base16-onedark.vim](https://github.com/chriskempson/base16-vim/blob/master/colors/base16-onedark.vim)
|
||||
* Associated base16 scheme: [tilal6991/base16-onedark-scheme](https://github.com/tilal6991/base16-onedark-scheme)
|
||||
* [rakr/vim-one](https://github.com/rakr/vim-one)
|
||||
* For Neovim >= 0.5 with treesitter support: [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim)
|
||||
* Neovim-only Lua port: [ii14/onedark.nvim](https://github.com/ii14/onedark.nvim)
|
||||
- [drewtempelmeyer/palenight.vim](https://github.com/drewtempelmeyer/palenight.vim)
|
||||
- [KeitaNakamura/neodark.vim](https://github.com/KeitaNakamura/neodark.vim)
|
||||
- [base16-onedark.vim](https://github.com/chriskempson/base16-vim/blob/master/colors/base16-onedark.vim)
|
||||
- Associated base16 scheme: [tilal6991/base16-onedark-scheme](https://github.com/tilal6991/base16-onedark-scheme)
|
||||
- [rakr/vim-one](https://github.com/rakr/vim-one)
|
||||
- For Neovim >= 0.5 with treesitter support: [navarasu/onedark.nvim](https://github.com/navarasu/onedark.nvim)
|
||||
- Neovim-only Lua port: [ii14/onedark.nvim](https://github.com/ii14/onedark.nvim)
|
||||
|
||||
### Preview images
|
||||
|
||||
Preview images were taken using:
|
||||
|
||||
* [iTerm2](https://iterm2.com) terminal emulator on macOS
|
||||
* 13 pt. [PragmataPro Mono](http://www.fsd.it/fonts/pragmatapro.htm#.VlDa1q6rTOY) font
|
||||
* [vim-polyglot](https://github.com/sheerun/vim-polyglot) plug-in
|
||||
- [iTerm2](https://iterm2.com) terminal emulator on macOS
|
||||
- 13 pt. [PragmataPro Mono](http://www.fsd.it/fonts/pragmatapro.htm#.VlDa1q6rTOY) font
|
||||
- [vim-polyglot](https://github.com/sheerun/vim-polyglot) plug-in
|
||||
|
||||
Reference in New Issue
Block a user