search

cosinekitty / astronomy

Astronomy Engine: multi-language calculation of Sun, Moon, and planet positions. Predicts lunar phases, eclipses, transits, oppositions, conjunctions, equinoxes, solstices, rise/set times, and other events. Provides vector and angular coordinate transforms among equatorial, ecliptic, horizontal, and galactic orientations.
MIT License
462 stars 63 forks source link

Internal doc links don't work #273

Open viridia opened 1 year ago

viridia commented 1 year ago

On the npmjs.com page (https://www.npmjs.com/package/astronomy-engine) there are a lot of links which have UR: fragment identifiers:

https://www.npmjs.com/package/astronomy-engine#HelioVector

However, clicking on these links does nothing - it looks like whatever markdown-to-HTML converter is being used doesn't include the anchor elements which would cause the page to scroll down to the linked topic.

cosinekitty commented 1 year ago

That is interesting. I don't know if I can do anything about how npmjs.com processes my original markdown. For now, it would be best to go directly to the original at

https://github.com/cosinekitty/astronomy/tree/master/source/js

viridia commented 1 year ago

Thanks that's helpful, I didn't know about that link. One suggestion, then, would be to embed the canonical doc link into the doc somewhere, so that when it shows up on npmjs.com, people can click on it to go to the github page and get the better experience.

cosinekitty commented 1 year ago

That's a good idea! I hadn't thought about how people would land on the npm page first, and not realize it was a slightly imperfect copy of the original documentation.