Skip to content
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.

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

Internal doc links don't work #273

Open
viridia opened this issue Nov 30, 2022 · 3 comments
Open

Internal doc links don't work #273

viridia opened this issue Nov 30, 2022 · 3 comments

Comments

@viridia
Copy link

viridia commented Nov 30, 2022

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
Copy link
Owner

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
Copy link
Author

viridia commented Nov 30, 2022

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
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants