pkgdown_pkgdown.yml

url: https://pkgdown.r-lib.org

home:
  title: Build websites for R packages

authors:
  Salim Brüggemann:
    href: https://salim.space
  Jay Hesselberth:
    href: https://hesselberthlab.org
  Maëlle Salmon:
    href: https://masalmon.eu
  Hadley Wickham:
    href: https://hadley.nz
  Posit Software, PBC:
    href: https://posit.co

template:
  bootstrap: 5
  math-rendering: mathjax
  light-switch: true
  bslib:
    primary: "#0054AD"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem
    danger: "#A6081A"
  includes:
    in_header:
      <script defer data-domain="pkgdown.r-lib.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>

development:
  mode: auto

articles:
- title: Customise your site
  navbar: ~
  contents:
  - customise
  - quarto
  - translations
  - accessibility
  - linking
  - metadata

- title: Advanced techniques
  contents:
  - how-to-update-released-site

- title: Testing
  desc: >
    These articles are used to test various pkgdown features that can not
    easily be tested automatically.
  contents:
  - starts_with("test")
  - starts_with("articles/test")

reference:
- title: Build

- subtitle: Build the complete site
  contents:
  - build_site
  - clean_site
  - preview_site
  - pkgdown_sitrep

- subtitle: Build part of a site
  desc: These functions are useful for rapid iteration when you're working on a
    specific part of your site.
  contents:
  - has_concept("site components")
  - build_search
  - build_redirects
  - init_site

- subtitle: Customisation
  contents:
  - template_navbar

- title: For expert use

- subtitle: Deployment
  contents:
  - starts_with("deploy_")
  - build_site_github_pages

- subtitle: Other helpers
  contents:
  - rd2html
  - as_pkgdown
  - in_pkgdown
  - render_page
  - build_favicons

- title: Regression tests
  contents:
  - starts_with("test", internal = TRUE)

- title: Deprecated functions
  contents:
  - has_lifecycle("deprecated")

redirects:
- ["articles/search.html", "reference/build_search.html"]

news:
  releases:
  - text: "Version 2.1.0"
    href: https://www.tidyverse.org/blog/2024/07/pkgdown-2-1-0/
  - text: "Version 2.0.0"
    href: https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/
  - text: "Version 1.6.0"
    href: https://www.tidyverse.org/blog/2020/09/pkgdown-1-6-0/
  - text: "Version 1.5.0"
    href: https://www.tidyverse.org/blog/2020/03/pkgdown-1-5-0/
  - text: "Version 1.4.0"
    href: https://www.tidyverse.org/articles/2019/09/pkgdown-1-4-0/
  - text: "Version 1.3.0"
    href: https://www.tidyverse.org/articles/2018/12/pkgdown-1-3-0/
  - text: "Version 1.1.0"
    href: https://www.tidyverse.org/articles/2018/06/pkgdown-1-1-0/
  - text: "Version 1.0.0"
    href: https://www.tidyverse.org/articles/2018/05/pkgdown-1-0-0/