Skip to content

[Feat]: Optional generation for a Table of Contents #288

@Ekkiheiti

Description

@Ekkiheiti

General Summary

Hey there! Thank you for your great work on this tool, it makes my life much easier! :)

I have a large values file with many sections and I am at a point where a Table of Contents at least for my values sections would be useful. A generated TOC with links to the sections would be a nice enhancement.

Is your feature request related to a problem? Please describe and/or link to a bug issue.

No bug issue found.

Expected Behavior

I would add something like {{ template "chart.valuesSectionToc" . }} to my README.md.gotmpl. After the execution of helm-docs I have a TOC with links to every values section.

Current Behavior

Currently not possible(?)

Possible Solution

No response

Alternatives you've considered

No response

Further Information

No response

Metadata

Metadata

Labels

enhancementNew feature or requesttriageIssues that need to be triaged and categorized

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions