{"Package":"pkgdown","Title":"Make Static HTML Documentation for a Package","Version":"2.1.2","Authors@R":"c(\nperson(\"Hadley\", \"Wickham\", , \"hadley@posit.co\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0003-4757-117X\")),\nperson(\"Jay\", \"Hesselberth\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-6299-179X\")),\nperson(\"Maëlle\", \"Salmon\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-2815-0399\")),\nperson(\"Olivier\", \"Roy\", role = \"aut\"),\nperson(\"Salim\", \"Brüggemann\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-5329-5987\")),\nperson(\"Posit Software, PBC\", role = c(\"cph\", \"fnd\"),\ncomment = c(ROR = \"03wc8by49\"))\n)","Description":"Generate an attractive and useful website from a source\npackage. 'pkgdown' converts your documentation, vignettes, 'README',\nand more to 'HTML' making it easy to share information about your\npackage online.","License":"MIT + file LICENSE","URL":"https://pkgdown.r-lib.org/, https://github.com/r-lib/pkgdown","BugReports":"https://github.com/r-lib/pkgdown/issues","Depends":"R (>= 4.0.0)","Imports":"bslib (>= 0.5.1), callr (>= 3.7.3), cli (>= 3.6.1), desc (>=\n1.4.0), downlit (>= 0.4.4), fontawesome, fs (>= 1.4.0), httr2\n(>= 1.0.2), jsonlite, openssl, purrr (>= 1.0.0), ragg (>=\n1.4.0), rlang (>= 1.1.4), rmarkdown (>= 2.27), tibble, whisker,\nwithr (>= 2.4.3), xml2 (>= 1.3.1), yaml","Suggests":"covr, diffviewer, evaluate (>= 0.24.0), gert, gt, htmltools,\nhtmlwidgets, knitr (>= 1.50), lifecycle, magick, methods,\npkgload (>= 1.0.2), quarto, rsconnect, rstudioapi, rticles,\nsass, testthat (>= 3.1.3), tools","VignetteBuilder":"knitr, quarto","Config/Needs/website":"usethis, servr","Config/potools/style":"explicit","Config/testthat/edition":"3","Config/testthat/parallel":"true","Config/testthat/start-first":"build-article, build-quarto-article,\nbuild-reference","Encoding":"UTF-8","RoxygenNote":"7.3.2.9000","SystemRequirements":"pandoc","NeedsCompilation":"no","Packaged":"2025-04-26 13:48:02 UTC; hadleywickham","Author":"Hadley Wickham [aut, cre] (),\nJay Hesselberth [aut] (),\nMaëlle Salmon [aut] (),\nOlivier Roy [aut],\nSalim Brüggemann [aut] (),\nPosit Software, PBC [cph, fnd] (03wc8by49)","Maintainer":"Hadley Wickham ","Repository":"CRAN","Date/Publication":"2025-04-28 10:00:05 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/pkgdown_2.1.2.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":"hadley@posit.co","maintainer":true},{"name":"Jay Hesselberth","email":null,"maintainer":false},{"name":"Maëlle Salmon","email":null,"maintainer":false},{"name":"Olivier Roy","email":null,"maintainer":false},{"name":"Salim Brüggemann","email":null,"maintainer":false},{"name":"Posit Software, PBC ","email":null,"maintainer":false}],"readme":"\n\n\n# pkgdown $\"\"$ \n\n\n\n [![Codecov test\ncoverage](https://codecov.io/gh/r-lib/pkgdown/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/pkgdown?branch=main)\n\n\npkgdown is designed to make it quick and easy to build a website for\nyour package. You can see pkgdown in action at\n: this is the output of pkgdown applied to\nthe latest version of pkgdown. Learn more in `vignette(\"pkgdown\")` or\n`?build_site`.\n\n## Installation\n\n

\n\n``` r\n# Install released version from CRAN\ninstall.packages(\"pkgdown\")\n```\n\n

\n\n

\n\n``` r\n# Install development version from GitHub\n# install.packages(\"pak\")\npak::pak(\"r-lib/pkgdown\")\n```\n\n

\n\n## Usage\n\nGet started with [usethis](https://usethis.r-lib.org/):\n\n``` r\n# Run once to configure your package to use and deploy pkgdown\nusethis::use_pkgdown_github_pages()\n```\n\n``` r\n# Preview your site locally before publishing\npkgdown::build_site()\n```\n\nThis adds the necessary components and sets up GitHub Actions[^1] for\nautomatic site building when deploying. Your `README.md` becomes the\nhomepage, documentation in `man/` generates a function reference, and\nvignettes will be rendered into `articles/`.\n\n### pkgdown 2.0.0 and Bootstrap 5\n\npkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which\nis accompanied by a whole bunch of minor UI improvements. If you’ve\nheavily customised your site, there’s a small chance that this will\nbreak your site, so everyone needs to explicitly opt-in to the upgrade\nby adding the following to `_pkgdown.yml`:\n\n``` yaml\ntemplate:\n bootstrap: 5\n```\n\nThen learn about the many new ways to customise your site in\n`vignette(\"customise\")`.\n\n## In the wild\n\nAt last count, pkgdown is used [by over 12,000\npackages](https://github.com/search?q=path%3A_pkgdown.yml+language%3AYAML&type=code&l=YAML).\nHere are a few examples:\n\n- [bayesplot](http://mc-stan.org/bayesplot/index.html)\n ([source](https://github.com/stan-dev/bayesplot/tree/gh-pages)):\n plotting functions for posterior analysis, model checking, and MCMC\n diagnostics.\n\n- [valr](https://rnabioco.github.io/valr/)\n ([source](https://github.com/rnabioco/valr)): read and manipulate\n genome intervals and signals.\n\n- [mkin](https://pkgdown.jrwb.de/mkin/)\n ([source](https://github.com/jranke/mkin)): calculation routines based\n on the FOCUS Kinetics Report\n\n- [NMF](http://renozao.github.io/NMF/master/index.html)\n ([source](https://github.com/renozao/NMF)): a framework to perform\n non-negative matrix factorization (NMF).\n\n- [tidyverse and r-lib packages\n source](https://github.com/search?q=path%3A%22_pkgdown.yml%22+AND+%28org%3Atidyverse+OR+org%3Ar-lib%29&type=code)\n\nComparing the source and output of these sites is a great way to learn\nnew pkgdown techniques.\n\n## Code of conduct\n\nPlease note that this project is released with a [Contributor Code of\nConduct](https://pkgdown.r-lib.org/CODE_OF_CONDUCT.html). By\nparticipating in this project you agree to abide by its terms.\n\n[^1]: If you don’t use GitHub, you can use `usethis::use_pkgdown()` +\n `pkgdown::build_site()` to create a website.","jobInfo":{"package":"pkgdown","version":"2.1.2","parsingStatus":"success","parserVersion":2,"parsedAt":"2025-04-28T12:29:54+0000"}}

Description

Arguments

See Also

Examples