https://github.com/LucasTavaresA/simpleIndentGuides.nvim

Indentation guides using the builtin variables.
https://github.com/LucasTavaresA/simpleIndentGuides.nvim

indentation lua neovim neovim-plugin nvim

Last synced: 9 days ago
JSON representation

Indentation guides using the builtin variables.

• Host: GitHub
• URL: https://github.com/LucasTavaresA/simpleIndentGuides.nvim
• Owner: LucasTavaresA
• License: gpl-3.0
• Created: 2022-11-07T05:23:13.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-10T02:40:45.000Z (almost 2 years ago)
• Last Synced: 2024-07-31T20:51:47.933Z (3 months ago)
• Topics: indentation, lua, neovim, neovim-plugin, nvim
• Language: Lua
• Homepage:
• Size: 25.4 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - LucasTavaresA/simpleIndentGuides.nvim - Indentation guides using the builtin variables. (Formatting / Indent)

README

        
# simpleIndentGuides.nvim

Indentation guides using the builtin `shiftwidth` and `listchars` variables.

![print_07_02:48](https://user-images.githubusercontent.com/80704612/200235123-f0b1c4dc-9159-47b7-bb4a-92e1c5e658db.png)

## Installation

**You have to use setup()**

[packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua

use {

  'lucastavaresa/simpleIndentGuides.nvim',

  config = function()

    vim.opt.list = true -- enable in all buffers

    require("simpleIndentGuides").setup()

  end

}

```

## Customization

To disable the guide in specific buffers

```lua

vim.api.nvim_create_autocmd("FileType", {

  pattern = { "markdown", "org", "txt", "norg" },

  command = "setlocal nolist",

})

```

Setup can receive one or two characters,

the first one is the guide,

the second string is the padding between the guides

The default guide is `│`

Example:

```lua

require("simpleIndentGuides").setup("┊")

```

Another example:

```lua

require("simpleIndentGuides").setup("┊", "·")

```