99 One Monokai Nvim
1010 </h1 >
1111
12- VSCode One Monokai colorscheme written in Lua for Neovim.
12+ A VSCode One Monokai-inspired colorscheme, rewritten in Lua for seamless Neovim integration .
1313</div >
1414
1515![ demo] ( https://user-images.githubusercontent.com/42694704/196934147-0704f7ec-456f-4a07-b44f-ac99896c7b22.png )
1616
17- <p align = " center " ><b >Normal background</b ></p >
17+ <p align = " center " ><b >Normal background</b ></p >
1818
1919<br />
2020
2121![ transparent demo] ( https://user-images.githubusercontent.com/42694704/196934131-0c7134ec-7266-4200-bf5a-901cf5d28e12.png )
2222
23- <p align = " center " ><b >Transparent background</b ></p >
23+ <p align = " center " ><b >Transparent background</b ></p >
2424
2525## :rocket : Installation
2626
3030}
3131```
3232
33- ### Requirement
33+ ### Requirements
3434
3535- Neovim >= 0.9.1
36- - [ nvim-treesitter] ( https://github.com/nvim-treesitter/nvim-treesitter ) for better syntax highlighting (optional) 😇
36+ - [ nvim-treesitter] ( https://github.com/nvim-treesitter/nvim-treesitter ) for enhanced syntax highlighting (optional) 😇
3737
3838## :gear : Setup
3939
4040``` lua
4141vim .cmd .colorscheme " one_monokai"
4242```
4343
44- Or prefer below if you want to customize some options
44+ Or use the following approach if you wish to customize options:
4545
4646``` lua
4747require (" one_monokai" ).setup ({
48- -- your options
48+ -- your custom options here
4949})
5050```
5151
52- ### Options
52+ ### Available Options
5353
54- | Option | Description | Type | Note |
55- | ------------- | ----------------------------- | -------------------------- | ---------------- |
56- | ` transparent ` | enable transparent background | ` boolean ` | N/A |
57- | ` colors ` | custom colors | ` table<string, string> ` | N/A |
58- | ` themes ` | custom highlight groups | ` function(colors): tables ` | ` :h nvim_set_hl ` |
59- | ` italics ` | enable italics | ` boolean ` | N/A |
54+ | Option | Description | Type | Note |
55+ | ------------- | -------------------------------- | -------------------------- | ---------------- |
56+ | ` transparent ` | Enables a transparent background | ` boolean ` | N/A |
57+ | ` colors ` | Custom color definitions | ` table<string, string> ` | N/A |
58+ | ` themes ` | Custom highlight groups | ` function(colors): tables ` | ` :h nvim_set_hl ` |
59+ | ` italics ` | Enables italic | ` boolean ` | N/A |
6060
61- ### Default
61+ ### Default Configuration
6262
6363``` lua
6464require (" one_monokai" ).setup ({
@@ -71,45 +71,47 @@ require("one_monokai").setup({
7171})
7272```
7373
74- ### Customization example
74+ ### Customization Examples
7575
76- #### Available colors and themes
76+ #### Available Colors and Themes
7777
78- 1 . [ colors ] ( lua/one_monokai/colors.lua#L7 )
79- 2 . [ themes ] ( lua/one_monokai/themes/groups.lua#L6 )
78+ 1 . [ Colors ] ( lua/one_monokai/colors.lua )
79+ 2 . [ Themes ] ( lua/one_monokai/themes/groups.lua )
8080
81- Color provides two method, ` darken ` and ` lighten ` to blend color based on provided
82- alpha value. You can access them via:
81+ The color module provides two methods, ` darken ` and ` lighten ` , to blend colors based on an alpha value (between 0 and 1). You can use them as follows:
8382
8483``` lua
8584colors [" <color-name>" ]:darken (alpha )
8685colors [" <color-name>" ]:lighten (alpha )
8786```
8887
89- #### Example
88+ #### Example Configuration
9089
9190``` lua
9291require (" one_monokai" ).setup ({
93- transparent = true , -- enable transparent window
92+ transparent = true , -- Enable transparent background
9493 colors = {
95- lmao = " #ffffff" , -- add new color
96- pink = " #ec6075" , -- replace default color
94+ lmao = " #ffffff" , -- Define a new color
95+ pink = " #ec6075" , -- Override a default color
9796 },
9897 themes = function (colors )
99- -- change highlight of some groups,
100- -- the key and value will be passed respectively to "nvim_set_hl"
98+ -- Customize highlight groups
99+ -- The key- value pairs are passed to "nvim_set_hl"
101100 return {
102101 Normal = { bg = colors .lmao },
103102 DiffChange = { fg = colors .white :darken (0.3 ) },
104103 ErrorMsg = { fg = colors .pink , standout = true },
105104 [" @lsp.type.keyword" ] = { link = " @keyword" }
106105 }
107106 end ,
108- italics = false , -- disable italics
107+ italics = false , -- Disable italic
109108})
110109```
111110
112- ## :champagne : Plugins support
111+ > [ !TIP]
112+ > To find the highlight group for an item, place the cursor inside it and run ` :Inspect ` . Refer to ` :h :Inspect ` for more information.
113+
114+ ## :champagne : Plugin Support
113115
114116- [ Lualine] ( https://github.com/nvim-lualine/lualine.nvim )
115117
@@ -126,9 +128,9 @@ require("lualine").setup {
126128
127129## :eyes : Inspiration
128130
129- 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 .
131+ This is, in my opinion, the best theme I’ve ever used. After using it in Vim for a long time, I rewrote it in Lua to ensure better compatibility with Neovim and to allow for easier customization .
130132
131- Thanks for these talented and amazing people :
133+ A huge thanks to these talented and inspiring creators :
132134
133135- [ one-monokai-vim] ( https://github.com/fratajczak/one-monokai-vim )
134136- [ vscode one-monokai] ( https://github.com/azemoh/vscode-one-monokai )
@@ -137,5 +139,4 @@ Thanks for these talented and amazing people:
137139
138140## :scroll : Contribution
139141
140- Please see [ the contributing guidelines] ( CONTRIBUTING.md ) for detailed
141- instructions on how to contribute to this colorscheme.
142+ For detailed instructions on how to contribute to this colorscheme, please see [ the contributing guidelines] ( CONTRIBUTING.md ) .
0 commit comments