Link to page + anchor could suggest removing trailing slash

[pawamoy]

If I write a link like this:

[Link to section](../page.md/#anchor)

Studio reports it as invalid link. I actually just need to remove the trailing slash to "fix it" (it already works when building/serving):

[Link to section](../page.md#anchor)

Maybe Studio could suggest removing the trailing slash 🙂
Or maybe both syntaxes could be supported.

[squidfunk]

Thanks for reporting! What's does MkDocs do here? We should deliberately decide if we can/want to be compatible, or if it makes sense to deviate and allow for more permissiveness.

[pawamoy]

Just tested: MkDocs gladly ignores the trailing slash. I think it makes sense to lint it so that users drop the trailing slash, because it's kinda misleading: we're not typing an URL but a relative path (+ an #anchor). But I guess it's OK to allow it too. Some could argue that it more clearly separates the #anchor from the rest (though I personally prefer the no-slash version). Maybe we also have to think about files having a literal # in their extension? In that case the trailing slash could become necessary.

[squidfunk]

IIRC, MkDocs treats a path that ends in a .ext as a file, regardless of a slash being present. I think that's wrong, since it makes it impossible to have folders with dots in them. I'm pretty sure (without checking) that in Zensical, we'd treat this as a folder, and if we don't, we should. We can then add a lint to Zensical Studio that detects those cases and normalizes them to not using a slash.

Maybe we also have to think about files having a literal # in their extension? In that case the trailing slash could become necessary.

Same argument applies. This should be valid:

• foo.ext/index.md
• foo#ext/index.md
• foo#ext/index.md#anchor

[pawamoy]

I really meant something like [link to asset](../file.some#weird#ext). But I checked a bit and extensions with # in them really don't seem to exist anyway.

[pawamoy]

Relevant: zensical/zensical#690

[squidfunk]

Zensical Studio now mirrors Zensical, and treats it as an invalid link. The repair functionality which we're going to release next week will show the likely repair and provide a code action to repair it:

[squidfunk]

Zensical Studio 0.2.14 has been released – just restart VS Code to automatically fetch the update! This now adds a new code action to broken links, as well as the hover preview which lists the most likely candidates for repair.