Generated default README.md fails markdownlint about helm-docs HOT 4 CLOSED

Hey @Arabus, I had not ever thought to lint the generated markdown, which probably would have been a good thing to do looking back on it...

Most of these line-length warnings are probably not reparable, unless you know a way to split table rows across multiple lines. Other than that though, I think sprucing up the template a bit so that most of these issues go away is a very good idea, and I'd be happy to review a PR if you want to make one.

Thanks for the interest, and I'm glad you're finding the tool helpful.

from helm-docs.

You could just expand default README.md.gotmpl with markdown linter tags to ignore certain rules for specific code sections. Notice, though, that there is a bit more rules to adjust.

Example below - line length for values section or bare urls:

{{ template "chart.header" . }}
{{ template "chart.description" . }}
{{ template "chart.versionLine" . }}

{{ template "chart.sourceLinkLine" . }}

{{ template "chart.requirementsSection" . }}

<!-- markdownlint-capture -->
<!-- markdownlint-disable MD013 MD034 -->

{{ template "chart.valuesSection" . }}

<!-- markdownlint-enable MD013 MD034 -->
<!-- markdownlint-restore -->

The main drawback is that the <!-- code persists within .md files so reading raw content may be sometimes unpleasant, so it is better to render .md to .html for better representation.

from helm-docs.

I refactored a little bit and applied 2 regex'es eliminating trailing spaces, multiple empty lines (3+) and some more restyling for better compatibility with MarkDownLint.

from helm-docs.

I think you've fixed most things, @Artus-LHIND. Thanks for the contribution, I'll close this for now. Reopen if there are still issues.

from helm-docs.