Skip to content

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

@neilisaur

Description

@neilisaur

Is there an existing issue for this?

  • 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

Metadata

Metadata

Labels

bugSomething isn't workingtriageIssues that need to be triaged and categorized

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions