Fix captioning on pkgdown

[mikeroswell]

I think Ben's solution to captioning should work fine, ultimately, but some work might need to happen to get css to be respected by the pkgdown machinery as well as the rendering of the README.md file on github.

[mikeroswell]

I'm not sure how dooable the "on github" part will end up being: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/foreignObject

[mikeroswell]

https://pragmaticpineapple.com/adding-custom-html-and-css-to-github-readme/

[bbolker]

IMO trying to get fancy CSS to work on the github side is too much trouble; the README presented on GitHub can be relatively simple and technical (basic goals of the package, how to install, where to ask questions, etc.), without any figures, while the index page presented on GH pages can have fancy stuff (figures etc.). For example, compare

• glmmTMB README
• glmmTMB GH pages (in this case it doesn't have very fancy CSS stuff, but it's HTML generated from an Rmd file, so it could ...)

[mikeroswell]

@bbolker , Thank you!

I'm a bit lost on some of these details, maybe you can point me to a simple template for how this all comes together. I don't yet understand

• how you get something other than README.md to be the index with pkgdown
• what you needed the pkgdown.extras package to do for you Do you have a slightly more streamlined example for me to stare at to replicate this structure without e.g. doing too much pkgdown.yaml editing and troubleshooting?

I like your setup. I was just reading about using latex to get colored text as an alternative: https://stackoverflow.com/a/73871251/8400969.

[bbolker]

how you get something other than README.md to be the index with pkgdown

make sure there's an index.html file present in the docs directory (or the root directory of the gh-pages branch - wherever your GH pages are drawing their material from)

what you needed the pkgdown.extras package to do for you

this is probably not necessary for you. We have Rnw vignettes, which are a pretty big pain to handle in pkgdown. (I would recommend avoiding LaTeX-based solutions on GH pages/with GH actions if you can, it takes a lot of fussing to set up the right LaTeX environments remotely)

[mikeroswell]

Thank you, Ben!!!