Skip to content

Commit

Permalink
chore: add features to README
Browse files Browse the repository at this point in the history
  • Loading branch information
qvalentin committed Oct 27, 2024
1 parent 5b1dcc4 commit 8b87747
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Helm-ls is a [helm](https://github.com/helm/helm) language server protocol [LSP]
- [coc.nvim setup](#cocnvim-setup)
- [VSCode](#vscode)
- [Emacs eglot setup](#emacs-eglot-setup)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)

Expand Down Expand Up @@ -304,6 +305,27 @@ Alternatively, you can include a comment such as the following at the top of Hel

# -*- mode: helm -*-

## Features

<details>
<summary>
<b>Hover</b>
</summary>

![demo for hover](https://raw.githubusercontent.com/mrjosh/helm-ls/chore/doc-features/readme-assets/hover.mp4)

<video width="630" height="300" src="https://raw.githubusercontent.com/mrjosh/helm-ls/chore/doc-features/readme-assets/hover.mp4"></video>

| Language Construct | Example Effect |
| ------------------ | ---------------------------------------------------------------------------------- |
| Values | `.Values.replicaCount` shows the value of `replicaCount` in the values.yaml files. |
| Built-In-Objects | `.Chart.Name` shows the name of the Chart. |
| Includes | `include "example.labels"` shows the defintion of the template. |
| Functions | `add` shows the docs of the add function. |
| Yaml in Templates | `Kind` shows the docs from the yaml-schema (via yaml-language-server). |

</details>

## Contributing

Thank you for considering contributing to Helm-ls project!
Expand Down
Binary file added readme-assets/hover.mp4
Binary file not shown.

0 comments on commit 8b87747

Please sign in to comment.