-
Notifications
You must be signed in to change notification settings - Fork 71
Closed as not planned
Description
If the default value of a key is a multi-line string, the resulting readme markdown table is broken.
Input:
## @param robots Static robots.txt content served by ALB load balancer for SEO/web crawler control
robots: "User-agent: *\nDisallow: /\n"Or (produces the same result):
## @param robots Static robots.txt content served by ALB load balancer for SEO/web crawler control
robots: |
User-agent: *
Disallow: /Result:
### Global parameters
| Name | Description | Value |
| -------- | --------------------------------------------------------------------------------- | ---------------------------- |
| `robots` | Static robots.txt content served by ALB load balancer for SEO/web crawler control | `User-agent: *
Disallow: /
` |I suggest replacing all newlines inside the default value with "\n" (escaped newline) when writing it to a markdown table cell. This will at least keep the table in a correct format.
Reactions are currently unavailable