readme-generator-for-helm
readme-generator-for-helm copied to clipboard
Keep leading spaces in descriptions
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
Result
## Parameters
### MRE
```yaml
foo:
bar: baz
```
| Name | Description | Value |
| ----- | ----------- | ----- |
| `foo` | | `bar` |
Expected Result
## Parameters
### MRE
```yaml
foo:
bar: baz
```
| Name | Description | Value |
| ----- | ----------- | ----- |
| `foo` | | `bar` |
Sorry for my very late response
I've just created an internal task to work on this issue. I hope to come back soon.
This is a really anoying bug
+1 Descriptions should be kept verbatim