README.md 2.0 K raw
1
# ansi-nvim
2
3
A colorscheme that adapts to your terminal colors through ANSI values
4
5
![Gif Demo](assets/ansi-nvim.gif)
6
7
8
> [!WARNING]
9
> This extension is still under development; if you experience problems please open an issue!
10
11
## Features
12
13
- Support for Neovim's built-in LSP
14
- Treesitter highlighting
15
- Plugin integrations:
16
  - Telescope
17
  - Indent Blankline
18
  - Nvim-notify
19
  - Rainbow parentheses
20
  - Nvim-cmp
21
  - vim-illuminate
22
  - LSP semantic tokens
23
  - mini.completion
24
  - nvim-dap-ui
25
26
## Installation
27
28
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
29
30
```lua
31
{
32
  'stevedylandev/ansi-nvim',
33
  lazy = false,
34
  priority = 1000,
35
  config = function()
36
    vim.cmd('colorscheme ansi')
37
    vim.opt.termguicolors = false
38
  end,
39
}
40
```
41
42
### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
43
44
```lua
45
use {
46
  'stevedylandev/ansi-nvim',
47
  config = function()
48
    vim.cmd('colorscheme ansi')
49
    vim.opt.termguicolors = false
50
  end
51
}
52
```
53
54
## Usage
55
56
Simply set the colorscheme in your Neovim configuration:
57
58
```lua
59
vim.cmd('colorscheme ansi')
60
```
61
62
If you don't see colors, make sure you have true color tured **off**. This is often turned on for colorschemes
63
64
```lua
65
vim.opt.termguicolors = false
66
```
67
68
## Configuration
69
70
You can configure the colorscheme by passing options to the setup function:
71
72
```lua
73
require('ansi').setup({
74
  -- All options default to true
75
  telescope = true,          -- Telescope plugin
76
  telescope_borders = false, -- Telescope borders
77
  indentblankline = true,    -- Indent-blankline plugin
78
  notify = true,             -- Nvim-notify plugin
79
  ts_rainbow = true,         -- Rainbow parentheses
80
  cmp = true,                -- Nvim-cmp plugin
81
  illuminate = true,         -- vim-illuminate plugin
82
  lsp_semantic = true,       -- LSP semantic tokens
83
  mini_completion = true,    -- mini.completion plugin
84
  dapui = true,              -- nvim-dap-ui plugin
85
})
86
```
87
88
## Credits
89
90
The base for this plugin is pulled from [base16-nvim](https://github.com/RRethy/base16-nvim)