Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dnamsons/kimbie.nvim
https://github.com/dnamsons/kimbie.nvim
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dnamsons/kimbie.nvim
- Owner: dnamsons
- License: mit
- Created: 2023-05-01T19:17:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-15T12:00:42.000Z (9 months ago)
- Last Synced: 2024-04-16T22:31:31.405Z (7 months ago)
- Language: Lua
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kimbie
A dark Neovim theme written in Lua. Includes extra themes for Kitty and Alacritty
## ✨ Features
- supports the latest Neovim 0.5 features like TreeSitter and LSP
- minimal inactive statusline (currently bugged)
- 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)
- **lualine** theme
### Plugin Support
- [TreeSitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [LSP Diagnostics](https://neovim.io/doc/user/lsp.html)
- [LSP Trouble](https://github.com/folke/lsp-trouble.nvim)
- [LSP Saga](https://github.com/glepnir/lspsaga.nvim)
- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
- [Git Gutter](https://github.com/airblade/vim-gitgutter)
- [Telescope](https://github.com/nvim-telescope/telescope.nvim)
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
- [WhichKey](https://github.com/liuchengxu/vim-which-key)
- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
- [Dashboard](https://github.com/glepnir/dashboard-nvim)
- [BufferLine](https://github.com/akinsho/nvim-bufferline.lua)
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
- [Lightline](https://github.com/itchyny/lightline.vim)
- [Neogit](https://github.com/TimUntersberger/neogit)
- [Barbar](https://github.com/romgrk/barbar.nvim)
## ⚡️ Requirements
- Neovim >= 0.5.0
## 📦 Installation
Install the theme with your preferred package manager:
[vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'dnamsons/kimbie.nvim'
```
[packer](https://github.com/wbthomason/packer.nvim)
```lua
use({ 'dnamsons/kimbie.nvim' })
-- use this branch for new treesitter highlights
use({ 'dnamsons/kimbie.nvim', branch = 'treesitter' })
```
## 🚀 Usage
Enable the colorscheme:
```vim
" Vim Script
lua require('onedark').setup()
```
```lua
-- Lua
require('onedark').setup()
```
To enable the `onedark` theme for `Lualine`, simply specify it in your lualine settings:
```lua
require('lualine').setup {
options = {
theme = 'onedark'
-- ... your lualine config
}
}
```
To enable the `onedark` colorscheme for `Lightline`:
```vim
" Vim Script
let g:lightline = {'colorscheme': 'onedark'}
```
## ⚙️ Configuration
> ❗️ configuration needs to be set **BEFORE** loading the color scheme with `colorscheme onedark`
| Option | Default | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| commentStyle | `italic` | Highlight style for comments (check `:help highlight-args` for options) |
| keywordStyle | `italic` | Highlight style for keywords (check `:help highlight-args` for options) |
| functionStyle | `NONE` | Highlight style for functions (check `:help highlight-args` for options) |
| variableStyle | `NONE` | Highlight style for variables and identifiers (check `:help highlight-args` for options) |
| transparent | `false` | Enable this to disable setting the background color |
| hideInactiveStatusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. |
| sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `{"qf", "vista_kind", "terminal", "packer"}` |
| darkSidebar | `true` | Sidebar like windows like `NvimTree` get a darker background |
| colors | `{}` | You can override specific color groups to use other groups or a hex color |
| customTelescope | `false` | Better telescope colors |
```lua
-- Example config in Lua
require("onedark").setup({
functionStyle = "italic",
sidebars = {"qf", "vista_kind", "terminal", "packer"},
-- Change the "hint" color to the "orange" color, and make the "error" color bright red
colors = {hint = "orange", error = "#ff0000"}
})
```
```vim
" Example config in vimscript
lua << EOF
require("onedark").setup({
functionStyle = "italic",
sidebars = {"qf", "vista_kind", "terminal", "packer"},
-- Change the "hint" color to the "orange" color, and make the "error" color bright red
colors = {hint = "orange", error = "#ff0000"}
})
```
### 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
```
## 🍭 Extras
Extra color configs for **Kitty**, and **Alacritty** can be found in [extras](extras/). To use them, refer to their respective documentation.
