search

bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts
https://bitnami.com
Apache License 2.0
221 stars 48 forks source link

After each section in generated Parameters section there are two new blank lines instead of one #50

Closed jakuboskera closed 1 year ago

jakuboskera commented 2 years ago

I am using markdownlint, which lint all Markdown files according these Markdown rules - including README.md files in Helm Charts.

Describe the bug When readme-generator-for-helm runs, it generates Parameters section where after each section it includes two blank new lines that goes against this markdown rule MD012 - Multiple consecutive blank lines. There should be only one new line after each section.

Currently it is a problem, because everytime Parameters section is generated, markdownlint says that this rule is not met because of that blank new lines.

Expected behavior It generates only one blank new line after each section in Parameters section and if this section is last section in Parameters section it won't add any blank new lines.

fmulero commented 1 year ago

Thanks @jakuboskera sorry for my late response. This issue should be resolved on the 2.5.0 release