search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
704 stars 175 forks source link

Vitepress: Use `textContentMappings` for sidebar? #546

Closed gossi closed 7 months ago

gossi commented 8 months ago

I make use of textContentMappings for some selected strings:

{
  "textContentMappings": {
    "kind.typeAlias.singular": "Type",
    "kind.typeAlias.plural": "Types",
  }
}

That is of course for the typedoc-plugin-markdown plugin. The typedoc-vitepress-theme yet relies on that one and fills the sidebar, that is the labels are different right now for me.

Wanted to raise the question if it would make sense to also use the textContentMappings from the vitepress plugin, too?

tgreyuk commented 8 months ago

yes agreed it should - i'll fix it.

tgreyuk commented 8 months ago

Fixed in:

"typedoc-plugin-markdown": "^4.0.0-next.45",
"typedoc-vitepress-theme": "^1.0.0-next.8",