helm-docs icon indicating copy to clipboard operation
helm-docs copied to clipboard

[Bug]: values.yaml values with backticks do not render correctly

Open neilisaur opened this issue 1 year ago • 0 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Current Behavior

A value enclosed in quotes with a Backtick will mess up rendering of the default value in markdown.

Example:

functionTemplate: "my_func(`value`)"

Will render as: "my_func(value)"

Expected Behavior

When backticks are present, escape code blocks with double-backticks, e.g.

``"my_func(`value`)"``

to produce: "my_func(`value`)"

Reference Chart

n/a

Reference Template

No response

Environment

No response

Link to helm-docs Logs

No response

Further Information

No response

neilisaur avatar Dec 18 '24 23:12 neilisaur