[idea] use Shinylive in pkg docs

[pawelru]

This is an idea that I would let you refine it better.

I would love to see the documentation (README, vignettes, function reference, etc.) more interactive using Shinylive.

Recently we created a small tool for that purpose roxy.shinylive. Feel free to use it. It's already in the modules packages and I think it's robust enough to be implemented in the core packages.

[pawelru]

Hey @vedhav, thanks for the PR. That was a great job. However, I'm still missing shinylive implementation in two places that are important especially for the new comers - it is README and getting started vignette. Would you mind adding this there as well so that we can close it for good? Thanks!

[vedhav]

Sure, I can add it in the getting started vignette. GitHub README does not support iframes as far as I can remember so I don't think it will be possible there.

[pawelru]

I'm typing on the phone so can't check it myself - does markdown support raw html? Maybe this way? Just a thought

[m7pr]

I would suggest creating README.Rmd file, that has a knitr chunk with below setting:

identical(Sys.getenv("IN_PKGDOWN"), "true")

so it is added only during the PKGDOWN build of docs.

Copied from the other places where we have more options for roxyshinylive.

{r shinylive_iframe_1, echo = FALSE, out.width = '150%', out.extra = 'style = "position: relative; z-index:1"', eval = requireNamespace("roxy.shinylive", quietly = TRUE) && knitr::is_html_output() && identical(Sys.getenv("IN_PKGDOWN"), "true")}

README.Rmd would require a new github automation which renders this file to README.md, each time README.Rmd is changed. Optionally a git hook preventing to change README.md manually. Something similar that we have for rendering documentation.

[pawelru]

Good idea! I was actually thinking about something simpler with hardcoded url (because I would probably not expect changes in the app code) but if you can do this via .Rmd then that would be even better!