question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Automatically treat relative links as cross-references

See original GitHub issue

I don’t know if this is within scope or not. It would be nice if relative links like

[link](page.html)

or

[link](page.html#header)

were automatically translated to cross-references, and especially if it didn’t require adding a (header)= to the header if the slug is already named that.

The former does not work at all (it produces an error). The latter does work, but I believe it is just treating it like an external link, meaning if there is a spelling mistake in the page.html#header part it won’t catch it.

A potential issue might be that Myst documents could be included alongside other documents, so you can’t guarantee that a page that you can’t find a reference to isn’t something that will be there anyway. I don’t know if that is the case.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:11 (11 by maintainers)

github_iconTop GitHub Comments

3reactions
asmeurercommented, May 27, 2020

Oh I didn’t know about that. I’ll give it a try. If you don’t want to make this a default that’s fine with me. I’ll leave you to discuss that. Either way though maybe Myst could document that it’s an option in the cross-reference docs.

0reactions
pradyunsgcommented, Oct 11, 2020

Yeap!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Create a cross-reference - Microsoft Support
In the document, type the text that begins the cross-reference. · On the Insert tab, click Cross-reference. · In the Reference type box,...
Read more >
Links and Cross References | DocFX website - NET
Automatic link doesn't support relative path. If you write something like <file.md> , it will be treated as an HTML tag rather than...
Read more >
Cross-References and Links - Paligo - Zendesk
Select Link and choose Cross-reference. You can enter your own text in the Link Label field or leave it blank if you want...
Read more >
Links and Cross References | Hugo
Links and Cross References. Shortcodes for creating links to documents. The ref and relref shortcodes display the absolute and relative ...
Read more >
Cross-referencing with Sphinx - Read the Docs
The doc role allows us to link to a page instead of just a section. The target name can be relative to the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found