ropensci / katex

Server side math to html rendering in R
https://docs.ropensci.org/katex/reference/katex.html
Other
37 stars 3 forks source link

Better documentation on when to use functions #8

Open drmowinckels opened 2 years ago

drmowinckels commented 2 years ago

Hey.

I'm working on getting some math into one of my packages, and am struggling to understand when its appropriate to use which katex rendering.

I'm using roxygen2 for documentation, and am wondering why its recommended to use \Sexpr[results=rd, stage=build] and not an r katex chunk

More specifically, I'm trying to set up some doc fragments to avoid having the same text all over the place, but rather rendering the docs and vignettes using common Rmd fragments, as described here: https://www.garrickadenbuie.com/blog/dry-vignette-and-readme/

Its working super for everything but math stuff, and I was hoping katex would be the solution, but things are not rendering as expected.

I have a small example repo: https://github.com/Athanasiamo/testing.katex Comments to what is working and not is in the hello function roxygen doc, in the vignette, and in the man/fragments file.