Keep leading spaces in descriptions

bitnami / readme-generator-for-helm

Auto generate READMEs for Helm Charts

https://bitnami.com

Apache License 2.0

212 stars 48 forks source link

Open jnodorp-jaconi opened 1 year ago

jnodorp-jaconi commented 1 year ago

Currently, leading spaces are removed, when a section description is generated. This is problematic for code sections:

README.md

## Parameters

values.yaml

## @section MRE

## @descriptionStart
## ```yaml
## foo:
##   bar: baz
## ```
## @descriptionEnd

## @param foo
foo: bar

## Parameters

### MRE

```yaml
foo:
bar: baz

Name	Description	Value
`foo`		`bar`


## Expected Result
````markdown
## Parameters

### MRE

```yaml
foo:
  bar: baz

Name	Description	Value
`foo`		`bar`

fmulero commented 6 months ago

Sorry for my very late response

I've just created an internal task to work on this issue. I hope to come back soon.

viceice commented 2 days ago

This is a really anoying bug