Skip to content

Markdown Guide should encourage CommonMark standard for links with spaces #454

@LeeSaferite

Description

@LeeSaferite

The CommonMark specification added support for link destinations with spaces as far back as v0.29 (2019-04-06) when the link was enclosed in < and >. The current markdown guide included in the library has a strong opinion about always using %20 for encoding spaces in the section on relative paths. While this works it is sub-optimal. The rendered page will show the %20 when you hover over a link without a link title. If we instead wrap those urls with angle brackets (<url or path here>), then spaces in the url/path will work properly. This also means that when editing the markdown files in an editor or IDE, the relative links will resolve properly as well.

I'm willing to submit a PR fixing this, I just wanted to open an issue to potentially discuss changing the markdown guide first.

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