Add custom source linker support for HTML output #341
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces an optional SourceLinkerFn parameter to htmlOutputResults and htmlOutput, enabling custom source linking logic instead of relying solely on the default URL-based linker.
Motivation
The current doc-gen4 implementation computes source links internally using a fixed algorithm based on sourceUrl?. While this works well for standard GitHub repositories, some use cases require more sophisticated source linking:
New type alias:
Updated signatures:
Backward Compatibility
sourceLinker?parameter defaults tonone, preserving existing behaviorsourceLinker?is none, the existingSourceLinker.sourceLinkeris usedExample usage: