Expose some utility functions for easier theme customization

[Jym77]

What package is the feature request related to?

typedoc-plugin-markdown

Background

So, I wanted to generate markdown documentation with no line number in source links (*). This is fairly easy thanks to the partials.source helper that I can overwrite in a custom theme. I merely copied member.source and remove the line number from the output.

However, that file uses markdown/link and utils/escape-chars which, as far as I can tell, are not exported by the package. So I had to copy them too (fortunately, that stops here). Of course, this gets a bit annoying and unstable…

=> So, would it make sense to export the libs content (likely with its own entry point, e.g. typescript-plugin-markdown/libs) to ease the writing of plugins?

(*) Reason: trying to get as stable output as possible to use them for API review in PR, which helps verifying the associated semver bumps. Line numbers can changes for irrelevant reasons.

Proposed solution

No response

[tgreyuk]

Yes, we can do that. My only hesitation is that this folder would effectively become part of the public API and therefore fall under SemVer. That said, I think it is stable enough for this to make sense.

I’ll give it some thought, but I’ll likely expose it in the next release.

[Jym77]

I guess that in my very specific case, exposing a sourceLinkName partial, or something similar would be enough (since we already have a sourceLinkTemplate for the URLs). But I can still see how exposing the utilities can help others writing themes.