search

yihui / litedown

A lightweight version of R Markdown
https://yihui.org/litedown/
Other
150 stars 2 forks source link

package documentation with litedown #24

Open jangorecki opened 1 week ago

jangorecki commented 1 week ago

it's possible that litedown will have its own implementation of package documentation someday.

Originally posted by @yihui in https://github.com/yihui/litedown/issues/22#issuecomment-2334876365

Filling out new issue so it is easier to be subscribed to this particular feature. I would find it very useful. pkgdown broke my CI setup at least twice by pulling in new OS deps. Exactly the problem where lite version would fit to improve reliability.

On a side note, base R has functions for package documentation built-in. We are using that inside data.table CI pipeline to generate lightweight html documentation, simply by installing pkg with INSTALL_opts="--html". https://github.com/Rdatatable/data.table/blob/619ca739aa7c176230cac9fd097a466f0804f7fa/.gitlab-ci.yml#L352C143-L352C164 https://rdatatable.gitlab.io/data.table/library/data.table/html/00Index.html

llrs commented 6 days ago

Another option is to use the new pkg2HTML() that CRAN wants to use to generate the manual pages for all CRAN packages. It also renders a single html page with all the help pages. HTH both

jangorecki commented 6 days ago

@llrs thanks for informing on that. Looks nice, and great that it is in base R. Although for publishing online as a website this single page may not be always ideal solution.