| 1 | # compline-nvim |
| 2 | |
| 3 | A soft, muted colorscheme for Neovim based on the [Compline](https://github.com/jblais493/compline) theme |
| 4 | |
| 5 |  |
| 6 | |
| 7 | ## Features |
| 8 | |
| 9 | - Support for Neovim's built-in LSP |
| 10 | - Treesitter highlighting |
| 11 | - Plugin integrations: |
| 12 | - Telescope |
| 13 | - Indent Blankline |
| 14 | - Nvim-notify |
| 15 | - Rainbow parentheses |
| 16 | - Nvim-cmp |
| 17 | - vim-illuminate |
| 18 | - LSP semantic tokens |
| 19 | - mini.completion |
| 20 | - nvim-dap-ui |
| 21 | |
| 22 | ## Installation |
| 23 | |
| 24 | ### Using [packer.nvim](https://github.com/wbthomason/packer.nvim) |
| 25 | |
| 26 | ```lua |
| 27 | use { |
| 28 | 'stevedylandev/compline-nvim', |
| 29 | config = function() |
| 30 | vim.cmd('colorscheme compline') |
| 31 | end |
| 32 | } |
| 33 | ``` |
| 34 | |
| 35 | ### Using [lazy.nvim](https://github.com/folke/lazy.nvim) |
| 36 | |
| 37 | ```lua |
| 38 | { |
| 39 | 'stevedylandev/compline-nvim', |
| 40 | lazy = false, |
| 41 | priority = 1000, |
| 42 | config = function() |
| 43 | vim.cmd('colorscheme compline') |
| 44 | end, |
| 45 | } |
| 46 | ``` |
| 47 | |
| 48 | ## Usage |
| 49 | |
| 50 | Simply set the colorscheme in your Neovim configuration: |
| 51 | |
| 52 | ```lua |
| 53 | vim.cmd('colorscheme compline') |
| 54 | ``` |
| 55 | |
| 56 | If you don't see colors, make sure you have true color support enabled: |
| 57 | |
| 58 | ```lua |
| 59 | vim.opt.termguicolors = true |
| 60 | ``` |
| 61 | |
| 62 | ## Configuration |
| 63 | |
| 64 | You can configure the colorscheme by passing options to the setup function: |
| 65 | |
| 66 | ```lua |
| 67 | require('compline-colorscheme').setup('compline', { |
| 68 | -- All options default to true |
| 69 | telescope = true, -- Telescope plugin |
| 70 | telescope_borders = false, -- Telescope borders |
| 71 | indentblankline = true, -- Indent-blankline plugin |
| 72 | notify = true, -- Nvim-notify plugin |
| 73 | ts_rainbow = true, -- Rainbow parentheses |
| 74 | cmp = true, -- Nvim-cmp plugin |
| 75 | illuminate = true, -- vim-illuminate plugin |
| 76 | lsp_semantic = true, -- LSP semantic tokens |
| 77 | mini_completion = true, -- mini.completion plugin |
| 78 | dapui = true, -- nvim-dap-ui plugin |
| 79 | }) |
| 80 | ``` |
| 81 | |
| 82 | ## Credits |
| 83 | |
| 84 | This colorscheme is based on the [Compline](https://github.com/jblais493/compline) theme by [jblais493](https://github.com/jblais493), adapted for Neovim with support for modern plugins and features. |
| 85 | |
| 86 | The plugin structure is based on [base16-nvim](https://github.com/RRethy/base16-nvim) by RRethy. |