We’re delighted to announce the release of pkgdown 2.2.0. pkgdown is designed to make it quick and easy to build a beautiful and accessible website for your package.
You can install it from CRAN with:
install.packages("pkgdown")This version of pkgdown has one major change: a new
pkgdown::build_llm_docs() function that automatically creates files that make it easier for LLMs to read your documentation. Concretely, this means two things:
You’ll get an
llms.txtat the root directory of your site.llms.txtis an emerging standard that provides an easy way for an LLM to get an overview of your site. pkgdown creates an overview by combining your README, your function index, and your article index: this should give the LLM a broad overview of what your package does, along with links to find out more.Every existing
.htmlon your site gets a corresponding.mdfile. These are generally easier for LLMs to understand because they contain just the content of the site, without any extraneous styling.
If you don’t want to generate these files, just add the following to your _pkgdown.yaml:
llm-docs: false
This release also includes new translations for Dutch and Japanese, removal of the long-deprecated autolink_html() and preview_page(), and a handful of other bug fixes and minor improvements. You can read about them all in the
release notes.
Acknowledgements
As always, a big thanks to everyone who helped make this release possible: @cderv, @chabld, @Danny-dK, @davidorme, @dmurdoch, @hadley, @hfrick, @IndrajeetPatil, @jayhesselberth, @jeroenjanssens, @jmgirard, @krlmlr, @lorenzwalthert, @maelle, @MichaelChirico, @pepijn-devries, @remlapmot, @rempsyc, @Rohit-Satyam, @royfrancis, @rparmm, @schloerke, @TimTaylor, and @usrbinr.