Add links to source code #46
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kostiantxn
commented
Dec 10, 2023
| var from = new Uri(_output); | ||
| var to = new Uri(member.Location.Path); | ||
|
|
||
| return $"[{text}]({from.MakeRelativeUri(to)}#L{member.Location.Start.Line + 1})"; |
There was a problem hiding this comment.
The line number format should be configurable. For example, GitHub uses #L3-L7, while Bitbucket uses #lines-3:7.
There was a problem hiding this comment.
What do you think about extracting a new MdRendererOptions class for tweaking such things?
For example, we could call the UseMdRenderer method on the pipeline with few ways:
(the old one)
pipeline
.UseMdRenderer("...");(the more customizable one)
pipeline
.UseMdRenderer(options => options
.CleanupOutputDir()
.UseGitHubMarkdown())There was a problem hiding this comment.
I think it's a really good idea! I was also planning to raise a ticket to create a configuration mechanism for the pipeline, which I'll do shortly. 👍
kostiantxn
commented
Dec 10, 2023
| var from = new Uri(_output); | ||
| var to = new Uri(member.Location.Path); | ||
|
|
||
| return $"[{text}]({from.MakeRelativeUri(to)}#L{member.Location.Start.Line + 1})"; |
There was a problem hiding this comment.
We should also consider adding columns to the URL (e.g., #L3C5).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #41.