Skip to content

Header slugger does not properly handle embedded HTML #3023

@Gerrit0

Description

@Gerrit0

Search terms

slugger, anchor links

Expected Behavior

TypeDoc's anchor generation output should match output generated by other common markdown renderers.

(with html in markdown turned off)
# foo <T>
(with html in markdown turned on)
# bar &lt;T&gt;

The above headers should have the slug foo-T and bar-T (if the slugger's lowercase option is off)

Actual Behavior

Today TypeDoc generates foo- and bar- due to stripping the HTML

Environment

  • TypeDoc version: 0.28.12

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions