Skip to content

Commit

Permalink
docs: hide videos in detail
Browse files Browse the repository at this point in the history
  • Loading branch information
qvalentin committed Nov 16, 2024
1 parent 6708b68 commit 6fbcb05
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nvim plugin for helm-ls

A lua plugin for [Helm](https://helm.sh/) adding additional features using [helm-ls](https://github.com/mrjosh/helm-ls/).
A neovim lua plugin for [Helm](https://helm.sh/) adding additional features using [helm-ls](https://github.com/mrjosh/helm-ls/).
The plugin can be used as an alternative to [towolf/vim-helm](https://github.com/towolf/vim-helm) for neovim.

The plugin is in early development.
Expand All @@ -9,10 +9,9 @@ The plugin is in early development.

- Filetypes for Helm

- experimental: Overwrite templates with their current values using virtual text [demo](https://github.com/mrjosh/helm-ls/issues/26#issuecomment-2308893242)
- experimental: Overwrite templates with their current values using virtual text (See [Demos](#demos))

- experimental: Show hints highlighting the effect of `nindent` and `indent` functions
![demo for indent hints](https://raw.githubusercontent.com/qvalentin/helm-ls.nvim/main/doc/gifs/indent-hints.gif)
- experimental: Show hints highlighting the effect of `nindent` and `indent` functions (See [Demos](#demos))

## Installing

Expand All @@ -32,7 +31,8 @@ If you are not using lazy make sure to call `require("helm-ls").setup()` in your

### Requirments

The plugin requires [helm-ls](https://github.com/mrjosh/helm-ls) and the helm tree-sitter grammar.
The plugin requires [helm-ls](https://github.com/mrjosh/helm-ls) and the helm tree-sitter grammar for the additional features.
Install the helm tree-sitter grammar using `TSInstall` after installing the [nvim-treesitter plugin](https://github.com/nvim-treesitter/nvim-treesitter).

```
:TSInstall helm
Expand All @@ -56,3 +56,9 @@ Default config:
},
}
```

## Demos

<video src="https://github.com/user-attachments/assets/efae6e15-58a7-48d4-99c2-fd74fbb3a1b0" width="100%" controls></video>

![demo for indent hints](https://raw.githubusercontent.com/qvalentin/helm-ls.nvim/main/doc/gifs/indent-hints.gif)

0 comments on commit 6fbcb05

Please sign in to comment.