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.

Sign up for GitHub

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

Jump to bottom

Should use_vignette support quarto? #1997

Open
jfunction opened this issue May 30, 2024 · 6 comments · May be fixed by #2015
Open

Should use_vignette support quarto? #1997

jfunction opened this issue May 30, 2024 · 6 comments · May be fixed by #2015
Labels
docs 💡 documentation, news, vignettes, website, etc tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day

Comments

@jfunction
Copy link

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
Copy link
Author

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

@jfunction
Copy link
Author

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”.

@jennybc
Copy link
Member

jennybc commented May 30, 2024

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.

@hadley
Copy link
Member

hadley commented Jun 10, 2024

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.

@jennybc jennybc added the docs 💡 documentation, news, vignettes, website, etc label Jun 25, 2024
@olivroy
Copy link
Contributor

olivroy commented Jun 27, 2024

Also use_article() should also be updated.

This was referenced Jul 4, 2024
Open
Closed
@jennybc jennybc added the tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day label Jul 22, 2024
@jennybc
Copy link
Member

jennybc commented Jul 22, 2024 •
edited
Loading

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs 💡 documentation, news, vignettes, website, etc tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Support Quarto articles olivroy/usethis
4 participants
@hadley @jennybc @jfunction @olivroy