Skip to content

Added function to generate a Quarto readme#2176

Open
VisruthSK wants to merge 8 commits intor-lib:mainfrom
VisruthSK:main
Open

Added function to generate a Quarto readme#2176
VisruthSK wants to merge 8 commits intor-lib:mainfrom
VisruthSK:main

Conversation

@VisruthSK
Copy link

@VisruthSK VisruthSK commented Sep 19, 2025

  • Added Quarto README generation
  • Refactored use_readme_* functions
  • Small documentation changes and such

usethis already exposes an API to quickly create a tempate README.Rmd and README.md, but Quarto wasn't supported. This PR adds Quarto support by leverging the existing templates and adjusting them slightly to allow qmds. I also refactored the now 3 readme functions, pulling common functionality out into a helper. I wrote a few tests as well--due to the new structure of the code, I didn't think it was necesssary to duplicate all the Rmd tests for qmds, but I could do that if needed.

I also opened r-lib/devtools#2620 concerning devtools helpers for README building.

Fixes #1671.

VisruthSK and others added 3 commits December 20, 2025 22:03
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@dieghernan
Copy link

May I suggest to add this line to the quarto template?

default-image-extension: ''

Otherwise some badges can get a png extension automatically, even when it is not appropriate, see quarto-dev/quarto-cli#6092

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

Successfully merging this pull request may close these issues.

Feature request: Add use_readme_qmd()

2 participants