diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0b8d187..77b85d3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,7 +12,7 @@ jobs: - name: panvimdoc uses: kdheepak/panvimdoc@main with: - vimdoc: my-template-docs + vimdoc: helm-ls-docs version: "Neovim >= 0.8.0" demojify: true treesitter: true diff --git a/README.md b/README.md index d8606c8..dc03390 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # Nvim plugin for helm-ls -[helm-ls](https://github.com/mrjosh/helm-ls/) +A 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. -**Major work in progress** +The plugin is in early development. -## Planned features +## Features -- **WIP**: Overwrite templates with their current values using virtual text [demo](https://github.com/mrjosh/helm-ls/issues/26#issuecomment-2308893242) +- Filetypes for Helm -- **WIP**: Show hints highlighting the effect of `nindent` and `indent` functions +- experimental: Overwrite templates with their current values using virtual text [demo](https://github.com/mrjosh/helm-ls/issues/26#issuecomment-2308893242) + +- 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) ## Installing @@ -29,7 +32,7 @@ If you are not using lazy make sure to call `require("helm-ls").setup()` in your ### Requirments -The plugin requires 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. ``` :TSInstall helm diff --git a/lua/helm-ls.lua b/lua/helm-ls.lua index 9dc7788..59a9339 100644 --- a/lua/helm-ls.lua +++ b/lua/helm-ls.lua @@ -3,7 +3,6 @@ ---@class Config ---@field conceal_templates table ---@field indent_hints table ----@field opt string Your config option local config = { conceal_templates = { enabled = true,