Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
glepnir committed May 1, 2024
1 parent 4f2af5f commit ff7d4f4
Showing 1 changed file with 19 additions and 27 deletions.
46 changes: 19 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,33 @@ A minimal less than ~130 lines and blazing fast indentline plugin. no much more

## Install

- Lazy.nvim

```lua
require('lazy').setup({
'nvimdev/indentmini.nvim',
event = 'BufEnter',
config = function()
require('indentmini').setup()
end,
})
```
install with any plugin management or default vim package.

## Config

- char -- string type default is ``,
- exclude -- table type add exclude filetype in this table
available config values in setup table.

- char -- string type default is ``,
- ucrrent -- boolean highlight current indent level
- exclude -- table type add exclude filetype in this table ie `{ 'markdown', 'xxx'}`

```lua
config = function()
require("indentmini").setup({
char = "|",
current = true,
exclude = {
"erlang",
"markdown",
}
})

-- Colors are applied automatically based on user-defined highlight groups.
-- There is no default value.
vim.cmd.highlight('IndentLine guifg=#123456')
-- Current indent line highlight
vim.cmd.highlight('IndentLineCurrent guifg=#123456')
require("indentmini").setup({}) -- use default config
end,
```

## Highlight

if your colorscheme not config the `IndentLine*` relate highlight group you should config it in
your neovim config.

```lua
-- Colors are applied automatically based on user-defined highlight groups.
-- There is no default value.
vim.cmd.highlight('IndentLine guifg=#123456')
-- Current indent line highlight
vim.cmd.highlight('IndentLineCurrent guifg=#123456')
```

## License MIT

0 comments on commit ff7d4f4

Please sign in to comment.