Bug with backticks on abstract classes

[iivvaannxx]

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

When exporting an abstract class the generated Markdown contains "invalid" syntax in the header, as it backticks the entire header and also the abstract keyword. This is only if you want to manually "backtick" your headers, as it's something I need in my docs (see pageTitleTemplates.member in config).

Is there another way to accomplish this without breaking the header backticks?

It leads to:

# ``abstract` className`

TypeDoc configuration

{
    "$schema": "https://typedoc-plugin-markdown.org/schema.json",
    "plugin": ["typedoc-plugin-markdown"],
  
    "cleanOutputDir": true,
    "includeVersion": true,
  
    "excludeExternals": true,
    "expandObjects": true,
    "expandParameters": true,
    "hideBreadcrumbs": true,
    "hidePageHeader": true,
    "useCodeBlocks": true,
    "useTsLinkResolution": true,
    "readme": "none",
  
    "indexFormat": "table",
    "parametersFormat": "table",
    "pageTitleTemplates": {
      "index": "`{projectName}`: `{version}`",
      "module": "`{name}`: {kind}",
      "member": "`{name}`"
    },

    "entryPoints": ["./index.ts"],
    "out": "docs/api-reference",

    "validation": {
      "notExported": false
    }
}

Expected behavior

Should render the following:

# `abstract` `className`

Reproduction

See in Stackblitz

[iivvaannxx]

I raised this as a bug before I discovered that the principal issue was pageTitleTemplates.member. Perhaps this is more a help-wanted than a bug. Apologies for the inconvenience.

[tgreyuk]

Thanks @iivvaannxx,

Couple of issues were highlighted here and have updated the pageTitleTemplates option to handle this use case.

The keyword has now been split out into a separate placeholder so you can do this:

"member": "`{codeKeyword} {name}`"

Which will render:

# `abstract ClassName`

You could separate both words in backtick but you would need to use JS function with conditional logic (rather than JSON string).

Please see https://www.typedoc-plugin-markdown.org/docs/options/display-options#pagetitletemplates for updated docs.

Hopefully this improves things a bit. Updates in typedoc-plugin-markdown@4.8.0.