fix: handle fields' multi-line comments

elastic / crd-ref-docs

Generates Kubernetes CRD API reference documentation

Apache License 2.0

103 stars 53 forks source link

Closed czeslavo closed 1 year ago

czeslavo commented 1 year ago

If an API type field comment is multi-line, it breaks rendering both Markdown and Asiidoc tables. This PR aims to fix this issue by:

turning newlines into two break lines (<br />) HTML elements in Markdown renderer,
turning newlines into hard break lines in Asiidoc renderer.

cla-checker-service[bot] commented 1 year ago

💚 CLA has been signed

thbkrkr commented 1 year ago

For Asiidoc, I wonder if we could use + or if this could be an issue given that we are in a table?

czeslavo commented 1 year ago

For Asiidoc, I wonder if we could use + or if this could be an issue given that we are in a table?

Yeah, it seems to be working fine. Both HTML and PDF render as expected. 👍 PTAL

thbkrkr commented 1 year ago

Thanks @czeslavo for your contribution!