search

etiennebacher / altdoc

Alternative to pkgdown to document R packages
https://altdoc.etiennebacher.com
Other
62 stars 9 forks source link

Quarto: `setup_quarto()` should warn if README.qmd does not exist. #280

Closed vincentarelbundock closed 1 month ago

vincentarelbundock commented 3 months ago

README.md is not sufficient. Must have a Quarto version.

roaldarbol commented 1 month ago

Just toying around with altdoc (which is great fun!) and came across this. Do you maintain both READMEs separately? Or do you use pandoc to convert between the two to ensure that you don't have to edit both (and that they're both updated)? :-)

vincentarelbundock commented 1 month ago

Thanks for trying!

Normally, you just maintain README.qmd, and that gets converted to README.md automatically every time you build the site.

roaldarbol commented 1 month ago

Ah, great - even within the main repository and not just in site? I'd probably document that somewhere.

vincentarelbundock commented 1 month ago

Well of course if you don't build the website locally or commit the new README.md to your repo, it won't show up on the Github landing. But if you build your website with a Github action, the website should use the updated README as its index page.