Improvements for html help manual

r-universe-org / help

Support and bug tracker for R-universe

https://docs.r-universe.dev/

8 stars 2 forks source link

Improvements for html help manual #217

Open jeroen opened 1 year ago

jeroen commented 1 year ago

[x] Add content index at the top, just like for pdf manuals
[x] Fix: referenced images under ../help need to be embedded
[x] sort by \name{} of the manual instead of the rdname
[ ] Make more clear what universe this is and link back to the package homepage
[ ] Load rd macros (see spelling/pkgdown)

noamross commented 1 year ago

Manual pages look great! I like that they are simple. I'd suggest setting a max width of the div of 800-1200px, I think the text is too wide when I open it in a full-screen browser:

I think that these should still display inside the nav wrapper like the main package pages:

Also, maybe make it a little clearer visually that the function titles are linkable ? Maybe display a #, color/underline them at least on hover?

noamross commented 1 year ago

Oo, another idea: could we add a "copy" button to the examples code blocks?