Skip to content

feat(processor): manually inject frontmatter with source tag #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moshams272 wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −0
Open

feat(processor): manually inject frontmatter with source tag #136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d5c753
feat(processor): manually inject frontmatter with source tag
moshams272 Jun 14, 2026
0deb1c6
fixup!
moshams272 Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions plugins/processor/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { Converter, ReflectionKind, Renderer } from 'typedoc';
import { MarkdownPageEvent } from 'typedoc-plugin-markdown';
import { getSourceMetadata } from './metadata.mjs';
import { writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { applyExportEqualsReflections } from './exportEquals.mjs';
Expand Down Expand Up @@ -62,6 +64,17 @@ export function load(app) {
}
});

app.renderer.on(MarkdownPageEvent.END, page => {
const sourceMeta = getSourceMetadata(page.model);

if (sourceMeta && sourceMeta.sourceRelativePath) {
const source = `https://github.com/webpack/webpack/edit/main/lib/${sourceMeta.sourceRelativePath}`;
const frontmatter = `---\n` + `source: ${source}\n` + `---\n\n`;

@avivkeller avivkeller Jun 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const frontmatter = `---\n` + `source: ${source}\n` + `---\n\n`;
const frontmatter = `---\nsource: ${source}\n---\n\n`;

@moshams272 moshams272 Jun 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put it like that to be more readable if we add more tags in future!


page.contents = frontmatter + page.contents;
}
});

app.renderer.on(Renderer.EVENT_END, () => {
// doc-kit resolves custom type annotations from this map while generating
// HTML, so use the final router URLs instead of recomputing paths here.
Expand Down