feat(processor): manually inject frontmatter with source tag#136
Open
moshams272 wants to merge 2 commits into
Open
feat(processor): manually inject frontmatter with source tag#136moshams272 wants to merge 2 commits into
moshams272 wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
avivkeller
reviewed
Jun 14, 2026
avivkeller
reviewed
Jun 14, 2026
|
|
||
| if (sourceMeta && sourceMeta.sourceRelativePath) { | ||
| const source = `https://github.com/webpack/webpack/blob/main/lib/${sourceMeta.sourceRelativePath}`; | ||
| const frontmatter = `---\n` + `source: ${source}\n` + `---\n\n`; |
Member
There was a problem hiding this comment.
Suggested change
| const frontmatter = `---\n` + `source: ${source}\n` + `---\n\n`; | |
| const frontmatter = `---\nsource: ${source}\n---\n\n`; |
Contributor
Author
There was a problem hiding this comment.
I put it like that to be more readable if we add more tags in future!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds
sourcefrontmatter in the API documentation pages, which is a blocker for the "Edit Page" button (#131) as mentioned in #132.Instead of relying on the
typedoc-plugin-frontmatter, this implementation manually injects the frontmatter block as a string at the beginning of the markdown content. By usingMarkdownPageEvent.ENDhook to access the final markdown string andsourceRelativePathto construct the full GitHub repository URL. This approach provides more control over the output and prevents conflicts withdoc-kit.After:
