Strikeout deprecated headings in sidemenu for docusaurus

[DominicGBauer]

What package is the feature request related to?

docusaurus-plugin-typedoc

Background

When using docusaurus plugin with sidemenu, the sidemenu title is not struck out when deprecated.

Proposed solution

It would really be nice if the sidemenu item is struck out when deprecated. Example from dart docs

[tgreyuk]

Yes can do this. Will need to expose an additional flag to navigation via typedoc-plugin-markdown too. Will add to list for next release.

[DominicGBauer]

Epic thanks @tgreyuk!

[tgreyuk]

This functionality is available in:

[email protected]
[email protected]

[DominicGBauer]

Hi @tgreyuk thanks a lot for this! Not to sound ungrateful but is it possible to make the strikeout more apparent and have the line not miss any space please?

It also looks like the font is changed from
Family name: .SF NS
PostScript name: .SFNS-Regular_wdth_opsz110000_GRAD_wght1F40000

to
Family name: Helvetica
PostScript name: Helvetica

when it is stricken out

[tgreyuk]

Thanks @DominicGBauer for feedback :)

The issue here is that the strikethough has been created with the Unicode \u0336 (combining long stroke overlay). What is happening is that the default font doesn't support this character so is falling back to a font that does.

Was probably a bit hasty getting this out and I think a plan B is required here.

New proposed solution is to add a class name to the relevant sidebar item. This could then be handled properly by css. Like so:

typedoc-sidebar.cjs (autogenerated sidebar)

Generated html:

docusaurus.config.js (added by user)

css/typedoc.css (added by user - could also be added to existing custom css if exists )

output:

Does this seem reasonable? It gives users greater flexibility - could make the class name configurable if useful.

[DominicGBauer]

Hi @tgreyuk yes please that would be brilliant! Thanks a lot :)

[tgreyuk]

@DominicGBauer [email protected]. See https://www.typedoc-plugin-markdown.org/plugins/docusaurus/sidebar#deprecated-sidebar-items.

[DominicGBauer]

This is perfect :D! Thank you very much @tgreyuk!