JuliaDocs / Documenter.jl

A documentation generator for Julia.
https://documenter.juliadocs.org
MIT License
799 stars 474 forks source link

On Hover Footnote Preview #2522

Open shravanngoswamii opened 3 weeks ago

shravanngoswamii commented 3 weeks ago

Added On-Hover Footnote Preview feature! I used a small jQuery script for fetching the footnote definitions from the end of the page and its working very fine!

Screenshot 2024-06-05 075038

closes #2080

fredrikekre commented 3 weeks ago

Nice. This would be awesome to have for docstring references too, but might be a bit more tricky since it doesn't have to be on the same page.

shravanngoswamii commented 3 weeks ago

Nice. This would be awesome to have for docstring references too, but might be a bit more tricky since it doesn't have to be on the same page.

I can look into that if you can just tell me the part of codebase which deals with it!

mortenpi commented 2 weeks ago

Very cool! It looks like you can run into some "layout" issues when you have small windows or are close to edges I guess:

image

I don't know if there are any easy ways to work around this or not. We can always iterate on it later as well, if there aren't.

A few other thoughts:

Generally, I think I'd be happy to merge this pretty much as is, and iterate in follow-up PRs. Or if you want to fiddle with it a bit more, we can also wait.

shravanngoswamii commented 2 weeks ago

I would be happy if you can wait a little! Sorry, actually I did not test it on small windows! I will make some changes in it as soon as I get some time!