Skip to content

Conversation

@aitap
Copy link
Member

@aitap aitap commented Jan 17, 2026

  • Use the xml2 package to merge the Rd2HTML output with the scripts and templates from _litedown.yml.
    This slightly reduces duplication (navigation header, footer, scripts, stylesheets are now loaded from the main configuration file) and makes the output more valid (another <html><body> inside the main <html><body> only works because the browser developers learned to be lenient during the Geocities time).
  • Use the information collected in the all_info variable to let tools::Rd2HTML know how to link between the data.table help pages.
    "External" links still don't work, but we don't have many links to [base] or other packages.

Should I add xml2 to the Docker image used to run the CI?

@aitap aitap requested a review from MichaelChirico as a code owner January 17, 2026 16:40
@aitap
Copy link
Member Author

aitap commented Jan 17, 2026

Nope, this auto-resolves external links such as \link[yaml]{yaml.load} to ../../../yaml/help/yaml.load.html for packages that are loaded in the Rscript session that runs tools::Rd2HTML.

Edit: Rd2HTML produces such links unconditionally, so remove them in post-processing as well.

@aitap aitap marked this pull request as draft January 17, 2026 18:07
@aitap aitap marked this pull request as ready for review January 17, 2026 18:51
@jangorecki
Copy link
Member

Thank you for looking after it. If you believe there is something that could be contributed to litedown rather than kept on our side, then it is something to consider. litedown is very fresh and needs polishing surely.

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.

2 participants