-
Notifications
You must be signed in to change notification settings - Fork 41
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
Markdown multiline code block displayed as single line #598
Comments
Looks like this is a bug when converting markdown to html. Exported Markdown file works fine. |
It's a pain but you need to insert empty lines:
|
I think that there is no way to do this. If we render the break line in the comments as a break line in the HTML this is really ugly, in this case it's not possible to split the big lines. Other way it's only support break line in comments == break line in HTML for code snippets. |
i did a workaround in 3fef984 |
Look a good starting point, but I think that it doesn't work for all the cases. I see the problems:
Myabe it's better to iterate all the descriptions after the parsing and to do, before to convert to MarkDown:
What do you think? |
Your are right, i totally forgot about the different comment symbol for verilog/sv. I will revisit this in a new PR. |
Describe the bug
In the documentation description, markdown multiline code blocks are displayed on a single line.
To Reproduce
Please complete the following information:
Screenshots
We get:
I expected (taken from https://markdownlivepreview.com/):
** Additional Context **
As far as I know, for Markdown one quote ' -> code displayed on a single line and 3 quotes ''' -> code should be displayed on multiple lines
The text was updated successfully, but these errors were encountered: