Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: handle fields' multi-line comments #53

Merged
merged 2 commits into from
Oct 13, 2023

Conversation

czeslavo
Copy link
Contributor

@czeslavo czeslavo commented Sep 20, 2023

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.

Should fix #52.

@cla-checker-service
Copy link

cla-checker-service bot commented Sep 20, 2023

💚 CLA has been signed

@thbkrkr
Copy link
Contributor

thbkrkr commented Sep 22, 2023

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

@czeslavo
Copy link
Contributor Author

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

@czeslavo czeslavo requested a review from thbkrkr October 13, 2023 08:51
@thbkrkr
Copy link
Contributor

thbkrkr commented Oct 13, 2023

Thanks @czeslavo for your contribution!

@thbkrkr thbkrkr merged commit 3bd5ba2 into elastic:master Oct 13, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken markdown table when empty lines are present in field description
2 participants