Skip to content

Preserve simple text formatting of non-RDL description text. #52

@amykyta3

Description

@amykyta3

If documentation is from a non-SystemRDL source like IP-XACT, it is not likely that it uses Markdown-friendly text. Even so, it is still common for 3rd party IP providers to use some form of sensible whitespace formatting. Currently, the Markdown processing ends up mangling this and making it quite unreadable.

When processing description text, first check the source file type. If it was imported from a non-RDL source, bypass Markdown processing and instead try to preserve source whitespace.

May be good to provide user control on what source filetypes are filtered.
May be necessary to augment the systemrdl-compiler source to provide information on the source importer information too..

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions