Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation on when to use functions #8

Open
drmowinckels opened this issue Mar 9, 2022 · 0 comments
Open

Better documentation on when to use functions #8

drmowinckels opened this issue Mar 9, 2022 · 0 comments

Comments

@drmowinckels
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant