Skip to content

Update mkdocs to render tables with multi line cells properly #581

@aruneshpa

Description

@aruneshpa

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: mkdocs/mkdocs#1384

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions