Skip to content

Would like to have word wrapping and line breaks in generated md docs #2282

@wonwuakpa-msft

Description

@wonwuakpa-msft

As the length of the content increases in the Short Long and Example params of the cobra.Command struct, the autogenerated docs are hard to read for the user. In my scenario, there is a long horizontal scroll.

Is there a way to auto wrap the md file based on the size of the screen or a set value? the filePrepender and linkHandler vars in the genMardownTreeCustom do not support this.

Image

My work around for this was to manually introduce line breaks "\n"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions