vm-operator icon indicating copy to clipboard operation
vm-operator copied to clipboard

Update mkdocs to render tables with multi line cells properly

Open aruneshpa opened this issue 1 year ago • 0 comments

What steps did you take and what happened?

The current project docs do not render tables with multi line cells. Any new line character is treated as a new row. For example, looking at this VirtualMachineClassSpec, we can see that the spec has been broken down in three rows instead of one column. Screenshot 2024-06-12 at 1 19 19 PM

What did you expect to happen?

Multi line table cell contents should be rendered properly.

Is there anything else you would like to add?

Looks like this is a known issue: https://github.com/mkdocs/mkdocs/issues/1384

The proposed solution is to use markdown extension: https://gitlab.com/WillDaSilva/markdown_grid_tables.

aruneshpa avatar Jun 12 '24 20:06 aruneshpa