{"Package":"pkgdown","Title":"Make Static HTML Documentation for a Package","Version":"2.0.2","Authors@R":"c(\nperson(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0003-4757-117X\")),\nperson(\"Jay\", \"Hesselberth\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-6299-179X\")),\nperson(\"Malle\", \"Salmon\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-2815-0399\")),\nperson(\"RStudio\", role = c(\"cph\", \"fnd\"))\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 (>= 3.1.0)","Imports":"bslib (>= 0.3.1), callr (>= 2.0.2), crayon, desc, digest,\ndownlit (>= 0.4.0), fs (>= 1.4.0), httr (>= 1.4.2), jsonlite,\nmagrittr, memoise, purrr, ragg, rlang (>= 0.4.0), rmarkdown (>=\n1.1.9007), tibble, whisker, withr (>= 2.4.3), xml2 (>= 1.3.1),\nyaml","Suggests":"covr, diffviewer, evaluate, htmltools, htmlwidgets, knitr,\nlifecycle, methods, openssl, pkgload (>= 1.0.2), rsconnect,\nrstudioapi, rticles, sass, testthat (>= 3.0.0), tools","VignetteBuilder":"knitr","Config/testthat/edition":"3","Config/potools/style":"explicit","Config/Needs/website":"usethis, servr","Encoding":"UTF-8","RoxygenNote":"7.1.2","SystemRequirements":"pandoc","NeedsCompilation":"no","Packaged":"2022-01-13 18:57:35 UTC; hadleywickham","Author":"Hadley Wickham [aut, cre] (),\nJay Hesselberth [aut] (),\nMalle Salmon [aut] (),\nRStudio [cph, fnd]","Maintainer":"Hadley Wickham ","Repository":"CRAN","Date/Publication":"2022-01-13 19:32:42 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/pkgdown_2.0.2.tar.gz","jsonAuthors":[{"name":"Hadley Wickham","email":"hadley@rstudio.com","maintainer":true},{"name":"Jay Hesselberth","email":null,"maintainer":false},{"name":"Malle Salmon","email":null,"maintainer":false},{"name":"RStudio ","email":null,"maintainer":false}],"readme":"\n\n\n# pkgdown $\"\"$ \n\n\n\n $\"CRAN$ \n $\"R-CMD-check\"$ \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\ndevtools::install_github(\"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 pkgdown\nusethis::use_pkgdown()\n```\n\nThen use pkgdown to build your website:\n\n``` r\npkgdown::build_site()\n```\n\nThis generates a `docs/` directory containing a website. Your\n`README.md` becomes the homepage, documentation in `man/` generates a\nfunction reference, and vignettes will be rendered into `articles/`.\nRead `vignette(\"pkgdown\")` for more details, and to learn how to deploy\nyour site to GitHub pages.\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.yaml`:\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 6,000\npackages](https://github.com/search?q=filename%3Apkgdown.yml+path%3A%2F&type=Code).\nHere are a few examples created by contributors to pkgdown:\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\n based 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\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.","jobInfo":{"package":"pkgdown","version":"2.0.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2022-04-24T17:30:31+0000"}}

Description

Arguments

See Also

Examples