Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cpea2506/one_monokai.nvim
One Monokai for Neovim
https://github.com/cpea2506/one_monokai.nvim
lua monokai neovim one-monokai theme
Last synced: about 21 hours ago
JSON representation
One Monokai for Neovim
- Host: GitHub
- URL: https://github.com/cpea2506/one_monokai.nvim
- Owner: cpea2506
- License: mit
- Created: 2021-10-29T05:06:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T14:14:15.000Z (6 months ago)
- Last Synced: 2024-07-31T20:48:56.113Z (3 months ago)
- Topics: lua, monokai, neovim, one-monokai, theme
- Language: Lua
- Homepage:
- Size: 4.12 MB
- Stars: 154
- Watchers: 1
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - cpea2506/one_monokai.nvim - One Monokai theme written in Lua. (Colorscheme / Tree-sitter Supported Colorscheme)
README
One Monokai Nvim
VSCode One Monokai colorscheme written in Lua for Neovim.
Normal background
Transparent background
## :rocket: Installation
```lua
{
"cpea2506/one_monokai.nvim",
}
```
### Requirement
- Neovim >= 0.9.1
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) for better syntax highlighting (optional) 😇
## :gear: Setup
```lua
vim.cmd.colorscheme "one_monokai"
```
Or prefer below if you want to customize some options
```lua
require("one_monokai").setup({
-- your options
})
```
### Options
| Option | Description | Type | Note |
| ------------- | ----------------------------- | -------------------------- | ---------------- |
| `transparent` | enable transparent background | `boolean` | N/A |
| `colors` | custom colors | `table` | N/A |
| `themes` | custom highlight groups | `function(colors): tables` | `:h nvim_set_hl` |
| `italics` | enable italics | `boolean` | N/A |
### Default
```lua
require("one_monokai").setup({
transparent = false,
colors = {},
themes = function(colors)
return {}
end,
italics = true,
})
```
### Customization example
#### Available colors and themes
1. [colors](lua/one_monokai/colors.lua#L7)
2. [themes](lua/one_monokai/themes/groups.lua#L6)
Color provides two method, `darken` and `lighten` to blend color based on provided
alpha value. You can access them via:
```lua
colors[""]:darken(alpha)
colors[""]:lighten(alpha)
```
#### Example
```lua
require("one_monokai").setup({
transparent = true, -- enable transparent window
colors = {
lmao = "#ffffff", -- add new color
pink = "#ec6075", -- replace default color
},
themes = function(colors)
-- change highlight of some groups,
-- the key and value will be passed respectively to "nvim_set_hl"
return {
Normal = { bg = colors.lmao },
DiffChange = { fg = colors.white:darken(0.3) },
ErrorMsg = { fg = colors.pink, standout = true },
["@lsp.type.keyword"] = { link = "@keyword" }
}
end,
italics = false, -- disable italics
})
```
## :champagne: Plugins support
- [Lualine](https://github.com/nvim-lualine/lualine.nvim)
```lua
require("lualine").setup {
options = {
-- ...other options
theme = "one_monokai"
}
}
```
## :eyes: Inspiration
This is the best theme I’ve ever seen in my eyes. I’ve tried it written in Vim for a long time and decided to write it in Lua for compatibility with Neovim, and make it easy to do some custom changes.
Thanks for these talented and amazing people:
- [one-monokai-vim](https://github.com/fratajczak/one-monokai-vim)
- [vscode one-monokai](https://github.com/azemoh/vscode-one-monokai)
- [tokyonight.nvim](https://github.com/folke/tokyonight.nvim)
- [onedarkpro.nvim](https://github.com/olimorris/onedarkpro.nvim)
## :scroll: Contribution
Please see [the contributing guidelines](CONTRIBUTING.md) for detailed
instructions on how to contribute to this colorscheme.