Skip to content

Fix LFS README image assets #113

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

Merged
stylessh merged 1 commit into from
Apr 14, 2026
Merged

Fix LFS README image assets #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 19 additions & 7 deletions apps/dashboard/src/components/repo/repo-markdown-files.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,15 @@ describe("resolveGitHubMarkdownAssetUrl", () => {
path: "README.md",
};

it("rebases root README relative assets to GitHub raw content", () => {
it("rebases root README relative assets to GitHub's raw route", () => {
expect(
resolveGitHubMarkdownAssetUrl(context, "assets/screenshot.png"),
).toBe(
"https://raw.githubusercontent.com/jakemor/kanna/main/assets/screenshot.png",
);
).toBe("https://github.com/jakemor/kanna/raw/main/assets/screenshot.png");
});

it("rebases root-relative assets from the repository root", () => {
expect(resolveGitHubMarkdownAssetUrl(context, "/assets/icon.png")).toBe(
"https://raw.githubusercontent.com/jakemor/kanna/main/assets/icon.png",
"https://github.com/jakemor/kanna/raw/main/assets/icon.png",
);
});

Expand All @@ -30,7 +28,7 @@ describe("resolveGitHubMarkdownAssetUrl", () => {
"../assets/demo image.png",
),
).toBe(
"https://raw.githubusercontent.com/jakemor/kanna/main/docs/assets/demo%20image.png",
"https://github.com/jakemor/kanna/raw/main/docs/assets/demo%20image.png",
);
});

Expand All @@ -41,10 +39,24 @@ describe("resolveGitHubMarkdownAssetUrl", () => {
"assets/screenshot.png",
),
).toBe(
"https://raw.githubusercontent.com/jakemor/kanna/feature/auth/assets/screenshot.png",
"https://github.com/jakemor/kanna/raw/feature/auth/assets/screenshot.png",
);
});

it("uses GitHub's raw route so LFS assets can redirect to media content", () => {
expect(
resolveGitHubMarkdownAssetUrl(
{
owner: "penso",
repo: "arbor",
ref: "main",
path: "README.md",
},
"assets/screenshot.png",
),
).toBe("https://github.com/penso/arbor/raw/main/assets/screenshot.png");
});

it("keeps absolute and anchor URLs unchanged", () => {
expect(
resolveGitHubMarkdownAssetUrl(
Expand Down
2 changes: 1 addition & 1 deletion apps/dashboard/src/components/repo/repo-markdown-files.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ export function resolveGitHubMarkdownAssetUrl(
return trimmedUrl;
}

const rootUrl = `https://raw.githubusercontent.com/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/${encodePath(ref)}/`;
const rootUrl = `https://github.com/${encodeURIComponent(owner)}/${encodeURIComponent(repo)}/raw/${encodePath(ref)}/`;
Copy link
Copy Markdown
Owner

@stylessh stylessh Apr 14, 2026

Choose a reason for hiding this comment

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

does this support all the other images urls?

Copy link
Copy Markdown
Contributor Author

@premsathisha premsathisha Apr 14, 2026

Choose a reason for hiding this comment

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

Yes!

const directoryPath = encodePath(getDirectoryPath(path));
const baseUrl = trimmedUrl.startsWith("/")
? rootUrl
Expand Down
Loading