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

Explore {litedown} for rendering vignettes #6394

Open
MichaelChirico opened this issue Aug 23, 2024 · 2 comments · May be fixed by #6583
Open

Explore {litedown} for rendering vignettes #6394

MichaelChirico opened this issue Aug 23, 2024 · 2 comments · May be fixed by #6583
Labels
documentation

Comments

@MichaelChirico
Copy link
Member

{knitr} requires R>=3.6.0; that means we can't render vignettes on our oldest supported versions of R (3.3, 3.4, 3.5).

@jangorecki sugegsts trying to render them instead with {litedown}:

d66e12b#r145771409

https://cran.r-project.org/web/packages/litedown/index.html

https://github.com/yihui/litedown

{litedown} is only 5 months old:

yihui/litedown@03db997

So we can expect to be among the first "major" users of the package if we make the switch -- I expect that to generate a decent amount of work filing/even fixing issues with upstream.

@jangorecki do you want to take the lead on owning the potential switch (exploring/validating/maintaining)?
@jangorecki
Copy link
Member

jangorecki commented Oct 1, 2024 •
edited
Loading

IMO we could as well move away from pkgdown to new yihui/litedown#24 (comment)
Pkgdown was causing extra burden with dependencies (new and many OS deps) and was at some point cached in a docker image, so it is not even updated in our CI for a longer while now.

@hturner hturner mentioned this issue Oct 1, 2024
Open
@ben-schwen ben-schwen linked a pull request Oct 19, 2024 that will close this issue
Draft
@ben-schwen
Copy link
Member

IMO we could as well move away from pkgdown to new yihui/litedown#24 (comment) Pkgdown was causing extra burden with dependencies (new and many OS deps) and was at some point cached in a docker image, so it is not even updated in our CI for a longer while now.

I would keep this as an extra issue, one step at a time!

This was referenced Oct 19, 2024
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

use litedown for rendering vignettes Rdatatable/data.table
3 participants
@jangorecki @MichaelChirico @ben-schwen