endless-sky / endless-sky-wiki

GNU General Public License v3.0
6 stars 18 forks source link

Improve "See gun port definition" link #58

Open SomeTroglodyte opened 1 month ago

SomeTroglodyte commented 1 month ago

Formatting and linking

Summary

a) CreatingOutfits has a link "See the gun port definition" which does link to the overall ship page, not the specific definition. It might not be obvious how to achieve anchors without using official markdown headers, but as long as github renders the markdown, it's possible. b) CreatingShips was using a fake footnote using the ¹ character - but footnotes do work in github-rendered markdown. Note I left the footnote text in its original place, but github will render it at the end of the page, with anchor-links to it and back - I'm using one below in this very comment.

Notes

[^1]: This led me to investigate in the first place

warp-core commented 1 month ago

The use of a markdown footnote here moves the text from where it currently is to the very bottom of the page. It also changes the colour and size of the text. I don't think that's a good change.

SomeTroglodyte commented 1 month ago

moves the text from where it currently is to the very bottom of the page

Yes, I said so. Given the current position waits until after the current list ends, it looks a little lost and out of context there anyway, and since it has no distinct visual characteristics, it's not easily clear it's meant as a footnote, not a continuation of the text immediately preceding it.

But yes - github's footnotes are a bit dim. All a matter of taste[^1]. And regrettably there is no intermediate option. I can fake a footnote reference and link it, and I can inline a fake footnote that looks mostly like a true footnote with or without the size and color changes - but github forcibly decorates custom href's with user-content and some guid, so those links won't work. Plus, that would be some more massive html injection with reliance on the framework's css not changing - nah.

[^1]: Just vote, I'll revert if y'all wannit. Just adding a space after the current 1 would already help a bit.

warp-core commented 1 day ago

If we're going to do anything with the footnote, I'd rather it be made not a footnote and included at an appropriate place in the documentation, rather than just using the actual markdown footnote formatting which just makes it less accessible.