docusaurus-plugin-typedoc-api icon indicating copy to clipboard operation
docusaurus-plugin-typedoc-api copied to clipboard

long string for package name

Open sedghi opened this issue 3 years ago • 5 comments
trafficstars

I have a long scope string and long package name which results in the following unfortunate render. I was wondering whether it is possible to define an alias for packages when passed in the docusaurus config?

image

sedghi avatar Mar 09 '22 23:03 sedghi

@sedghi There's no alias currently.

But I agree, I run into this on my own stuff. I think I need to come up with a more holistic solution. One thought I had is to just not include the @scope.

milesj avatar Mar 10 '22 00:03 milesj

yes, scope is not necessary IMO either

sedghi avatar Mar 10 '22 01:03 sedghi

One thought I had is to just not include the @scope.

Please make this configurable, removing the scope may sounds like a good idea, but not all monorepos have all packages namespaced.

Ideally we should be able to override the package name explicitly to have absolute control.

B4nan avatar Mar 10 '22 08:03 B4nan

Yeah I would do it through an option :)

milesj avatar Mar 10 '22 17:03 milesj

Added a removeScopes option: https://github.com/milesj/docusaurus-plugin-typedoc-api/commit/301a38aedc81e6975bf358abb81ecb3cc77fd6f0

milesj avatar Mar 29 '22 19:03 milesj