Skip to content

Commit

Permalink
Merge pull request #219 from mpluhar/master
Browse files Browse the repository at this point in the history
Update documentation for default template
  • Loading branch information
norwoodj committed Mar 2, 2024
2 parents a8411d8 + 4d874f9 commit 429636e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -256,6 +256,7 @@ can be used as well:
| chart.valuesTableHtml | Like `chart.valuesTable` but it is rendered as (X)HTML tags to allow further rendering customization, instead of markdown tables format. |
| chart.valuesSectionHtml | Like `chart.valuesSection` but uses `chart.valuesTableHtml` |
| chart.valueDefaultColumnRender | This is a hook template if you want to redefine how helm-docs render the default values in `chart.valuesTableHtml` mode. This is especially useful when combined with (X)HTML tags, so that you can nicely format multiline default values, like YAML/JSON object tree snippet with codeblock syntax highlighter, which is not possible or difficult when using the markdown table format. It can be redefined in your template file. |
| helm-docs.versionFooter | A footer that contains the version of helm docs being used. |

The default internal template mentioned above uses many of these and looks like this:
```
Expand All @@ -275,6 +276,9 @@ The default internal template mentioned above uses many of these and looks like
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
{{ template "helm-docs.versionFooter" . }}
```

The tool also includes the [sprig templating library](https://github.com/Masterminds/sprig), so those functions can be used
Expand Down

0 comments on commit 429636e

Please sign in to comment.