pkgdown
pkgdown copied to clipboard
r-lib
Generate static html documentation for an R package
Fixes #2187 - mimics the comments in Usage as seen in R-4 documentation.
I noticed that the latest pkgdown shows “S3 method for default” in Usage for any `foo.default()` function, e.g. `as_tibble.default`: https://tibble.tidyverse.org/reference/as_tibble.html ```r # S3 method for table as_tibble(x, `_n` = "n",...
I gather from #1540 that pkgdown's current (non) handling of `\dontshow` is intentional. There's a specific use we make of `\dontshow` in several packages and I'm wondering if it's compelling...
@maelle pointed out that the official twitter card validator is not working: https://twitter.com/ma_salmon/status/1549997623792238594 pkgdown users will probably naturally try to use it since it's recommended in the `metadata.Rmd` vignette, and...
https://quarto.org/docs/authoring/language.html#custom-translations - for quickly adding/testing a language translation - for, well, custom tastes such as #2181
This is incredibly inconvenient when trying to, well, create a documentation site that looks nice.
https://github.com/r-lib/pkgdown/blob/676cf1dce39e4dc5aa1bcb671b1e14e992589a0a/vignettes/how-to-update-released-site.Rmd#L46 https://github.com/r-lib/pkgdown/blob/676cf1dce39e4dc5aa1bcb671b1e14e992589a0a/vignettes/how-to-update-released-site.Rmd#L231 A lot of the writing is focused on _how_ to copy files across branches/tags, but I've read and not come away with a solid understanding of _why_ this...
https://github.com/r-lib/pkgdown/blob/676cf1dce39e4dc5aa1bcb671b1e14e992589a0a/vignettes/how-to-update-released-site.Rmd#L290 `_pkgdown.yml` is one of the files I track in the [`r-ci-samples` repo](https://github.com/MichaelChirico/r-ci-samples): https://github.com/MichaelChirico/r-ci-samples/tree/master/pkgdown The other advice here basically covers what you'll get from the `r-ci-samples` repo, the advantage is...
https://github.com/r-lib/pkgdown/blob/676cf1dce39e4dc5aa1bcb671b1e14e992589a0a/vignettes/how-to-update-released-site.Rmd#L197 I'm always wary of "in the future" usage in documentation without a specific work tracker backing it up -- it feels like either (a) this will never actually happen...