Skip to content

Commit

Permalink
docs: cleanup and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qvalentin committed Nov 16, 2024
1 parent 790ccb4 commit ddd1908
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion lua/helm-ls.lua
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit ddd1908

Please sign in to comment.