Skip to content

Fix assuming _snippets files only live one folder deep when resolving relative image links inside of them #1242

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
merged 1 commit into from
May 9, 2025
Merged

Fix assuming _snippets files only live one folder deep when resolving relative image links inside of them #1242

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
1 change: 0 additions & 1 deletion src/Elastic.Markdown/Myst/Directives/ImageBlock.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ private void ExtractImageUrl(ParserContext context)

ImageUrl = DiagnosticLinkInlineParser.UpdateRelativeUrl(context, imageUrl);


var file = DiagnosticLinkInlineParser.ResolveFile(context, imageUrl);
if (file.Exists)
Found = true;
Expand Down
21 changes: 19 additions & 2 deletions src/Elastic.Markdown/Myst/InlineParsers/DiagnosticLinkInlineParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,25 @@ public static string UpdateRelativeUrl(ParserContext context, string url)

// if we are trying to resolve a relative url from a _snippet folder ensure we eat the _snippet folder
// as it's not part of url by chopping of the extra parent navigation
if (newUrl.StartsWith("../") && context.DocumentationFileLookup(context.MarkdownSourcePath) is SnippetFile)
newUrl = url[3..];
if (newUrl.StartsWith("../") && context.DocumentationFileLookup(context.MarkdownSourcePath) is SnippetFile snippet)
{
//figure out how many nested folders inside `_snippets` we need to ignore.
var d = snippet.SourceFile.Directory;
var offset = 0;
while (d is not null && d.Name != "_snippets")
{
d = d.Parent;
if (d is not null && d.Name != "_snippets")
offset++;
}

//Because we ignore these folders in the url structure we need to eat the relative paths
while (offset >= 0 && newUrl.StartsWith("../"))
{
newUrl = newUrl[3..];
offset--;
}
}

// TODO check through context.DocumentationFileLookup if file is index vs "index.md" check
var markdownPath = context.MarkdownSourcePath;
Expand Down
Loading