Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Ekkiheiti opened this issue Mar 12, 2025 · 0 comments
Open

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

Ekkiheiti opened this issue Mar 12, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request triage Issues that need to be triaged and categorized

Comments

@Ekkiheiti
Copy link

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

@Ekkiheiti Ekkiheiti added enhancement New feature or request triage Issues that need to be triaged and categorized labels Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Issues that need to be triaged and categorized
Projects
None yet
Development

No branches or pull requests

3 participants