{"id":13405746,"url":"https://github.com/r-lib/pkgdown","last_synced_at":"2025-05-13T00:33:19.864Z","repository":{"id":2728694,"uuid":"3723845","full_name":"r-lib/pkgdown","owner":"r-lib","description":"Generate static html documentation for an R package","archived":false,"fork":false,"pushed_at":"2025-04-29T12:26:34.000Z","size":35525,"stargazers_count":741,"open_issues_count":52,"forks_count":338,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-03T01:50:38.694Z","etag":null,"topics":["documentation-tool","package","r"],"latest_commit_sha":null,"homepage":"https://pkgdown.r-lib.org/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/r-lib.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2012-03-15T00:36:24.000Z","updated_at":"2025-05-01T12:59:16.000Z","dependencies_parsed_at":"2023-07-05T20:46:15.311Z","dependency_job_id":"c940d0e2-e3c5-458b-9dcd-0fdca4909688","html_url":"https://github.com/r-lib/pkgdown","commit_stats":{"total_commits":2121,"total_committers":130,"mean_commits":"16.315384615384616","dds":"0.32343234323432346","last_synced_commit":"d5432a4e04655c6f9903196890f6bf166fbbd86b"},"previous_names":["hadley/staticdocs"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fpkgdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fpkgdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fpkgdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/r-lib%2Fpkgdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/r-lib","download_url":"https://codeload.github.com/r-lib/pkgdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253850279,"owners_count":21973661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-tool","package","r"],"created_at":"2024-07-30T19:02:10.232Z","updated_at":"2025-05-13T00:33:19.832Z","avatar_url":"https://github.com/r-lib.png","language":"R","funding_links":[],"categories":["R","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/\"\n)\n```\n\n# pkgdown \u003cimg src=\"man/figures/logo.png\" align=\"right\" alt=\"\" width=\"120\" /\u003e\n\n\u003c!-- badges: start --\u003e\n[![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)](https://cran.r-project.org/package=pkgdown){.pkgdown-release}\n[![R-CMD-check](https://github.com/r-lib/pkgdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/pkgdown/actions/workflows/R-CMD-check.yaml){.pkgdown-devel}\n[![Codecov test coverage](https://codecov.io/gh/r-lib/pkgdown/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/pkgdown?branch=main)\n\u003c!-- badges: end --\u003e\n\npkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at \u003chttps://pkgdown.r-lib.org\u003e: this is the output of pkgdown applied to the latest version of pkgdown. Learn more in `vignette(\"pkgdown\")` or `?build_site`.\n\n## Installation\n\n::: .pkgdown-release\n```{r, eval = FALSE}\n# Install released version from CRAN\ninstall.packages(\"pkgdown\")\n```\n:::\n\n::: .pkgdown-devel\n```{r, eval = FALSE}\n# Install development version from GitHub\n# install.packages(\"pak\")\npak::pak(\"r-lib/pkgdown\")\n```\n:::\n\n## Usage\n\nGet started with [usethis](https://usethis.r-lib.org/):\n\n```{r, eval = FALSE}\n# Run once to configure your package to use and deploy pkgdown\nusethis::use_pkgdown_github_pages()\n```\n\n```{r, eval = FALSE}\n# Preview your site locally before publishing\npkgdown::build_site()\n```\n\nThis adds the necessary components and sets up GitHub Actions[^1] for automatic site building when deploying.\nYour `README.md` becomes the homepage, documentation in `man/` generates a function reference, and vignettes will be rendered into `articles/`.\n\n[^1]: If you don't use GitHub, you can use `usethis::use_pkgdown()` + `pkgdown::build_site()` to create a website.\n\n### pkgdown 2.0.0 and Bootstrap 5\n\npkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which is accompanied by a whole bunch of minor UI improvements. If you've heavily customised your site, there's a small chance that this will break your site, so everyone needs to explicitly opt-in to the upgrade by 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 `vignette(\"customise\")`.\n\n## In the wild\n\nAt last count, pkgdown is used [by over 12,000 packages](https://github.com/search?q=path%3A_pkgdown.yml+language%3AYAML\u0026type=code\u0026l=YAML). Here 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)): \n  read and manipulate genome intervals and signals.\n\n* [mkin](https://pkgdown.jrwb.de/mkin/)\n  ([source](https://github.com/jranke/mkin)):\n  calculation routines based on the FOCUS Kinetics Report\n\n* [NMF](http://renozao.github.io/NMF/master/index.html)\n  ([source](https://github.com/renozao/NMF)):\n  a framework to perform non-negative matrix factorization (NMF).\n\n* [tidyverse and r-lib packages source](https://github.com/search?q=path%3A%22_pkgdown.yml%22+AND+%28org%3Atidyverse+OR+org%3Ar-lib%29\u0026type=code)\n\nComparing the source and output of these sites is a great way to learn new pkgdown techniques.\n\n## Code of conduct\n\nPlease note that this project is released with a [Contributor Code of Conduct](https://pkgdown.r-lib.org/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fpkgdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fr-lib%2Fpkgdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fr-lib%2Fpkgdown/lists"}