Virt-Indent.nvim/README.md

35 lines
1.2 KiB
Markdown

# Virt-Indent.nvim
Add virtual indentation to align content under headlines to their headings.
## Markdown Showcase
_Before:_
![Before](./assets/before.png)
_After:_
![After](./assets/after.png)
## Quick Start
### Requirements
- Neovim 0.10.0 or later
### Installation
- [**lazy.nvim**](https://github.com/folke/lazy.nvim)
```lua
{
"PriceHiller/Virt-Indent.nvim",
ft = { "org", "markdown" },
}
```
## Credits
This plugin is a module extracted from [nvim-orgmode](https://github.com/nvim-orgmode/orgmode/), specifically its [`virtual-indent`](https://github.com/nvim-orgmode/orgmode/blob/master/lua/orgmode/ui/virtual_indent.lua) module and adds additional support for more filetypes beyond org files.
- [@danilshvalov](https://github.com/danilshvalov), the original creator of some of this code. I ultimately took the existing code he wrote and carried a PR with my own additions to completion and integration into nvim-orgmode.
- [@kristijanhusak](https://github.com/kristijanhusak), the creator/maintainer of nvim-orgmode. He has done an amazing amount of work on that plugin and much of what was done in this plugin would not have come into being without him.