usethis icon indicating copy to clipboard operation
usethis copied to clipboard

Should use_vignette support quarto?

Open jfunction opened this issue 1 year ago • 6 comments

I'm not sure if this is a feature request, an opinion request or something else.

I am building a package and want to include some vignettes. The community is, broadly speaking, moving from Rmd to qmd. The use_vignette() function assumes you want all your vignettes in Rmd format.

I'm wondering if we are generally happy to use Rmd for vignettes still or if there is likely going to be a shift towards using quarto here also? Obviously in the latter case a change in use_vignette would be needed also.

jfunction avatar May 30 '24 13:05 jfunction

See here for example https://cran.r-project.org/web//packages//quarto/vignettes/hello.html

jfunction avatar May 30 '24 13:05 jfunction

That said, I found this quote from Packages 2e:

In vignettes, more than anywhere else, the answer to “But how do I do X?” is often “Don’t do X”.

jfunction avatar May 30 '24 13:05 jfunction

Yeah it's good to put this on the radar now. It's quite recent that quarto is a viable vignette engine, so it makes sense for usethis to become aware of this new reality.

jennybc avatar May 30 '24 18:05 jennybc

pkgdown should support quarto vignettes soon (hopefully by the end of the week), so I think we should plan to make this an option, and then over the next few years transition to making it the default for new vignettes.

hadley avatar Jun 10 '24 20:06 hadley

Also use_article() should also be updated.

olivroy avatar Jun 27 '24 14:06 olivroy

This is probably too big to fully resolve during tidyverse dev day, but it's a meaty issue that one could certainly get a decent start on. Probably best to begin with some planning and discussion (versus quickly starting a PR).

jennybc avatar Jul 22 '24 21:07 jennybc