Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mawkler/onedark.nvim
Atom's iconic One Dark theme for Neovim, written in Lua
https://github.com/mawkler/onedark.nvim
Last synced: about 2 months ago
JSON representation
Atom's iconic One Dark theme for Neovim, written in Lua
- Host: GitHub
- URL: https://github.com/mawkler/onedark.nvim
- Owner: mawkler
- License: mit
- Created: 2021-11-24T07:19:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T19:15:06.000Z (6 months ago)
- Last Synced: 2024-05-05T15:33:03.463Z (5 months ago)
- Language: Lua
- Homepage:
- Size: 253 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
**This is a fork of the now archived repository [ful1e5/onedark.nvim](https://github.com/ful1e5/onedark.nvim).**
Atom's iconic One Dark theme for Neovim, written in Lua
## Features
- Supports the latest Neovim 0.5 features like TreeSitter and LSP
- Minimal inactive StatusLine
- Vim terminal colors
- Darker background for sidebar-like windows
- Color configs for [Kitty](https://sw.kovidgoyal.net/kitty/conf.html?highlight=include) and [Alacritty](https://github.com/alacritty/alacritty)
- Beautiful **lualine** theme
## Requirements
- Neovim >= 0.5.0
## Installation
Install the theme with your preferred package manager:
[vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'ful1e5/onedark.nvim'
```
[packer](https://github.com/wbthomason/packer.nvim)
```lua
use 'ful1e5/onedark.nvim'
```
## Usage
Enable the colorscheme:
```vim
" Vim Script
colorscheme onedark
```
```lua
-- Lua
require('onedark').setup()
```
## Configuration
| Option | Default | Description |
| ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| colors | `{}` | You can override specific color groups to use other groups or a hex color. |
| comment_style | `italic` | Highlight style for comments (check `:help highlight-args` for options) |
| dark_float | `false` | Float windows like the lsp diagnostics windows get a darker background. |
| dark_sidebar | `true` | Sidebar like windows like `NvimTree` get a darker background. |
| dev | `false` | Developer Mode. |
| function_style | `NONE` | Highlight style for functions (check `:help highlight-args` for options) |
| hide_end_of_buffer | `true` | Enabling this option, will hide filler lines (~) after the end of the buffer. |
| hide_inactive_statusline | `true` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine**. |
| highlight_linenumber | `false` | Enabling this option, will enable dark color to `LineNr`, `SignColumn` and `CursorLineNr` highlights.(also support [gitsigns](https://github.com/lewis6991/gitsigns.nvim) plugin) |
| keyword_style | `italic` | Highlight style for keywords (check `:help highlight-args` for options) |
| lualine_bold | `false` | When `true`, section headers in the lualine theme will be bold. |
| msg_area_style | `NONE` | Highlight style for messages and cmdline (check `:help highlight-args` for options) |
| overrides | `function` | Override specific highlight groups. The function accpet colors as argument. You can also add a non-exists highlight by enabling the `dev` mode. |
| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` |
| transparent | `false` | Enable this to disable setting the background color. |
| transparent_sidebar | `false` | Sidebar like windows like `NvimTree` get a transparent background. |
| variable_style | `NONE` | Highlight style for variables and identifiers (check `:help highlight-args` for options) |
```vim
" Example config in VimScript
" configuration needs to be set BEFORE loading the color scheme with `colorscheme` command
let g:onedark_function_style = "italic"
let g:onedark_sidebars = ["qf", "vista_kind", "terminal", "packer"]
" Change the "hint" color to the "orange0" color, and make the "error" color bright red
let g:onedark_colors = {
\ 'hint': 'orange0',
\ 'error': '#ff0000'
\ }
" Load the colorscheme
colorscheme onedark
```
```lua
-- Example config in Lua
require("onedark").setup({
function_style = "italic",
sidebars = {"qf", "vista_kind", "terminal", "packer"},
-- Change the "hint" color to the "orange0" color, and make the "error" color bright red
colors = {hint = "orange0", error = "#ff0000"},
-- Overwrite the highlight groups
overrides = function(c)
return {
htmlTag = {fg = c.red0, bg = "#282c34", sp = c.hint, style = "underline"},
DiagnosticHint = {link = "LspDiagnosticsDefaultHint"},
-- this will remove the highlight groups
TSField = {},
}
end
})
```
### Lualine Support
To enable the `onedark` theme for `Lualine`, simply specify it in your lualine settings:
```lua
require('lualine').setup {
options = {
theme = 'onedark-nvim',
-- ... your lualine config
}
}
```
## Terminal Themes
> To generate the configs `make terminal` or `:luafile lua/onedark/terminal/init.lua`
Extra color configs for **kitty**, and **Alacritty** can be found in [terminal](terminal/) directory. To use them, refer to their respective documentation.
- kitty - [./terminal/kitty](https://github.com/ful1e5/onedark.nvim/tree/main/terminal/kitty)
- Alacritty - [./terminal/alacritty](https://github.com/ful1e5/onedark.nvim/tree/main/terminal/alacritty)
### Making `undercurls` work properly in **Tmux**
To have undercurls show up and in color, add the following to your **Tmux** config file:
```sh
# Undercurl
set -g default-terminal "${TERM}"
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm' # undercurl support
set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m' # underscore colours - needs tmux-3.0
```
## Plugin Support
- [Builtin LSP diagnostics](https://neovim.io/doc/user/lsp.html)
- [TimUntersberger/neogit](https://github.com/TimUntersberger/neogit)
- [airblade/vim-gitgutter](https://github.com/airblade/vim-gitgutter)
- [akinsho/nvim-bufferline.lua](https://github.com/akinsho/nvim-bufferline.lua)
- [folke/lsp-trouble.nvim](https://github.com/folke/lsp-trouble.nvim)
- [ggandor/lightspeed.nvim](https://github.com/ggandor/lightspeed.nvim)
- [glepnir/dashboard-nvim](https://github.com/glepnir/dashboard-nvim)
- [glepnir/lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim)
- [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
- [kyazdani42/nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua)
- [lambdalisue/glyph-palette.vim](https://github.com/lambdalisue/glyph-palette.vim)
- [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
- [liuchengxu/vim-which-key](https://github.com/liuchengxu/vim-which-key)
- [lukas-reineke/indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)
- [neoclide/coc.nvim](https://github.com/neoclide/coc.nvim)
- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
- [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [phaazon/hop.nvim](https://github.com/phaazon/hop.nvim)
- [projekt0n/circles.nvim](https://github.com/projekt0n/circles.nvim)
- [rcarriga/nvim-notify](https://github.com/rcarriga/nvim-notify)
- [romgrk/barbar.nvim](https://github.com/romgrk/barbar.nvim)
## Inspirations
- [Binaryify/OneDark-Pro](https://github.com/Binaryify/OneDark-Pro)
- [monsonjeremy/onedark.nvim](https://github.com/monsonjeremy/onedark.nvim)
- [folke/tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
- [eddyekofo94/gruvbox-flat.nvim](https://github.com/eddyekofo94/gruvbox-flat.nvim)
## Screenshot
- Font: [JetBrains Mono](https://www.jetbrains.com/lp/mono/)
- Terminal: [kitty](https://sw.kovidgoyal.net/kitty)
- dotfiles: [ful1e5/dotfiles](https://github.com/ful1e5/dotfiles/tree/main/nvim/.config/nvim)
### Default
### Normal
```vim
" VimScript
let g:onedark_comment_style = "NONE"
let g:onedark_keyword_style = "NONE"
let g:onedark_function_style = "NONE"
let g:onedark_variable_style = "NONE"
```
```lua
-- Lua
require("onedark").setup({
comment_style = "NONE",
keyword_style = "NONE",
function_style = "NONE",
variable_style = "NONE"
-- ... your onedark config
})
```
### Italic
```vim
" VimScript
let g:onedark_comment_style = "italic"
let g:onedark_keyword_style = "italic"
let g:onedark_function_style = "italic"
let g:onedark_variable_style = "italic"
```
```lua
-- Lua
require("onedark").setup({
comment_style = "italic",
keyword_style = "italic",
function_style = "italic",
variable_style = "italic"
-- ... your onedark config
})
```
### Minimal
```vim
" VimScript
let g:onedark_hide_inactive_statusline = 1
let g:onedark_dark_sidebar = 0
let g:onedark_dark_float = 0
```
```lua
-- Lua
require("onedark").setup({
hide_inactive_statusline = true,
dark_sidebar = false,
dark_float = false
-- ... your onedark config
})
```
### Highlight Line-Number
```vim
" VimScript
let g:onedark_highlight_linenumber = 1
```
```lua
-- Lua
require("onedark").setup({
highlight_linenumber = true
-- ... your onedark config
})
```
### Telescope
