diff --git a/dev/articles/test/jss.pdf b/dev/articles/test/jss.pdf
index 00b496ef0..ace426cb6 100644
Binary files a/dev/articles/test/jss.pdf and b/dev/articles/test/jss.pdf differ
diff --git a/dev/articles/test/pdf.pdf b/dev/articles/test/pdf.pdf
index 513e84275..e11d75003 100644
Binary files a/dev/articles/test/pdf.pdf and b/dev/articles/test/pdf.pdf differ
diff --git a/dev/articles/test/widgets.html b/dev/articles/test/widgets.html
index 4905a323b..91354c804 100644
--- a/dev/articles/test/widgets.html
+++ b/dev/articles/test/widgets.html
@@ -117,7 +117,7 @@ <h2 id="widgets">Widgets<a class="anchor" aria-label="anchor" href="#widgets"></
 </h2>
 <p>Test spacing above widget.</p>
 <div class="visual_diff html-widget html-fill-item" id="htmlwidget-ac96cb3ee4656e2e9ec3" style="width:700px;height:432.632880098888px;"></div>
-<script type="application/json" data-for="htmlwidget-ac96cb3ee4656e2e9ec3">{"x":{"old":"a\nb\nc\nd\ne\nf\ng\nh\ni\nj\nk\nl\nm\nn\no\np\nq\nr\ns\nt\nu\nv\nw\nx\ny\nz\n","new":"a\nb\nc\nd\ne\nf\ng\nh\ni\nl\nm\nn\no\np\nq\nr\ns\nt\nu\nv\nw\nx\ny\nz\n","filename":"file2ae85fa56d01","typediff":"text"},"evals":[],"jsHooks":[]}</script><p>Test spacing below widget.</p>
+<script type="application/json" data-for="htmlwidget-ac96cb3ee4656e2e9ec3">{"x":{"old":"a\nb\nc\nd\ne\nf\ng\nh\ni\nj\nk\nl\nm\nn\no\np\nq\nr\ns\nt\nu\nv\nw\nx\ny\nz\n","new":"a\nb\nc\nd\ne\nf\ng\nh\ni\nl\nm\nn\no\np\nq\nr\ns\nt\nu\nv\nw\nx\ny\nz\n","filename":"file2b0c753f3c71","typediff":"text"},"evals":[],"jsHooks":[]}</script><p>Test spacing below widget.</p>
 </div>
   </main>
 </div>
diff --git a/dev/news/index.html b/dev/news/index.html
index e7acbfdcf..6239b6c74 100644
--- a/dev/news/index.html
+++ b/dev/news/index.html
@@ -73,7 +73,9 @@ <h6 class="dropdown-header" data-toc-skip>Releases</h6>
 
     <div class="section level2">
 <h2 class="pkg-version" data-toc-text="development version" id="pkgdown-development-version">pkgdown (development version)<a class="anchor" aria-label="anchor" href="#pkgdown-development-version"></a></h2>
-<ul><li>The left and right footers no longer contain an extra empty paragraph tag and the footer gains additional padding-top to keep the whitespace constant (<a href="https://github.com/r-lib/pkgdown/issues/2381" class="external-link">#2381</a>).</li>
+<ul><li>
+<code><a href="../reference/build_reference.html">build_reference_index()</a></code> gives more informative errors if your <code>contents</code> field is malformed (<a href="https://github.com/r-lib/pkgdown/issues/2323" class="external-link">#2323</a>).</li>
+<li>The left and right footers no longer contain an extra empty paragraph tag and the footer gains additional padding-top to keep the whitespace constant (<a href="https://github.com/r-lib/pkgdown/issues/2381" class="external-link">#2381</a>).</li>
 <li>
 <code>build_article_index()</code> and <code><a href="../reference/build_reference.html">build_reference_index()</a></code> use an improved BS5 template that correctly wraps each section description in a <code>&lt;div&gt;</code>, rather than a <code>&lt;p&gt;</code>. This eliminates an empty pargraph tag that preceded each section description (<a href="https://github.com/r-lib/pkgdown/issues/2352" class="external-link">#2352</a>).</li>
 <li>
diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml
index 8a516beaa..0e79314cd 100644
--- a/dev/pkgdown.yml
+++ b/dev/pkgdown.yml
@@ -14,7 +14,7 @@ articles:
   search: search.html
   short: test/short.html
   widgets: test/widgets.html
-last_built: 2024-04-17T12:32Z
+last_built: 2024-04-17T12:51Z
 urls:
   reference: https://pkgdown.r-lib.org/reference
   article: https://pkgdown.r-lib.org/articles
diff --git a/dev/search.json b/dev/search.json
index 2d84c10c5..f8ff98195 100644
--- a/dev/search.json
+++ b/dev/search.json
@@ -1 +1 @@
-[{"path":"https://pkgdown.r-lib.org/dev/CODE_OF_CONDUCT.html","id":null,"dir":"","previous_headings":"","what":"Contributor Code of Conduct","title":"Contributor Code of Conduct","text":"contributors maintainers project, pledge respect people contribute reporting issues, posting feature requests, updating documentation, submitting pull requests patches, activities. committed making participation project harassment-free experience everyone, regardless level experience, gender, gender identity expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion. Examples unacceptable behavior participants include use sexual language imagery, derogatory comments personal attacks, trolling, public private harassment, insults, unprofessional conduct. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct. Project maintainers follow Code Conduct may removed project team. Instances abusive, harassing, otherwise unacceptable behavior may reported opening issue contacting one project maintainers. Code Conduct adapted Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available http://contributor-covenant.org/version/1/0/0/","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to pkgdown","title":"Contributing to pkgdown","text":"document outlines propose change pkgdown. detailed info contributing tidyverse packages, please see tidyverse contribution guide.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"pkgdown-and-pandoc-versions","dir":"","previous_headings":"","what":"pkgdown and Pandoc versions","title":"Contributing to pkgdown","text":"versions pkgdown Pandoc used build website stored public facing pkgdown.yml file, e.g. https://dplyr.tidyverse.org/pkgdown.yml.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"package-reprexes","dir":"","previous_headings":"","what":"Package reprexes","title":"Contributing to pkgdown","text":"encounter unexpected errors running pkgdown::build_site(), try build minimal package recreates error. ideal minimal package dependencies, making easy install quickly reproduce error. example minimal package issue, minimal package containing single .R file two lines reproduce error. quickest way set minimal example package usethis::create_package(): built minimal package recreates error, create GitHub repository package (e.g. usethis::use_git() + usethis::use_github()), file issue link repository.","code":"usethis::create_package(\"~/desktop/testpackage\") # ... edit files ... pkgdown::build_site(tmp, new_process = FALSE, preview = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"rd-translation","dir":"","previous_headings":"","what":"Rd translation","title":"Contributing to pkgdown","text":"encounter problems Rd tags, please use rd2html() create reprexes:","code":"library(pkgdown)  rd2html(\"a\\n%b\\nc\") rd2html(\"a & b\")"},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"","what":"Pull request process","title":"Contributing to pkgdown","text":"recommend create Git branch pull request (PR). Look Travis AppVeyor build status making changes. README contain badges continuous integration services used package. New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat. Contributions test cases included easier accept. user-facing changes, add bullet top NEWS.md current development version header describing changes made followed GitHub username, links relevant issue(s)/PR(s).","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"netlify","dir":"","previous_headings":"Pull request process","what":"Netlify","title":"Contributing to pkgdown","text":"might ask Netlify preview changes .e. local changes affect pkgdown website? Build install amended package, re-build website (clean_site() build_site()) update docs/ folder. Log Netlify https://app.netlify.com/sites/, scroll bottom. ’ll see box dashed outline says “Want deploy new site without connecting Git?”. Open file browser, navigate docs/, drag docs/ folder dashed box, copy files temporary netlify site. file transfer completes, netlify generate temporary URL new page can copy/paste PR discussion.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to pkgdown","text":"Small typos grammatical errors documentation may edited directly using GitHub web interface, long changes made source file. YES: edit roxygen comment .R file R/. : edit .Rd file man/.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"prerequisites","dir":"","previous_headings":"","what":"Prerequisites","title":"Contributing to pkgdown","text":"make substantial pull request, always file issue make sure someone team agrees ’s problem. ’ve found bug, create associated issue illustrate bug minimal reprex.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to pkgdown","text":"Please note pkgdown project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://pkgdown.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 pkgdown authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting started","title":"Customise your site","text":"theming features work Bootstrap 5, first update site adding following lines _pkgdown.yml: Overall, site look pretty similar, notice number small improvements. importantly, default font much bigger, making considerably easier read. Upgrading Bootstrap 5 low chance breaking site unless using pkgdown templates custom CSS.","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"theming","dir":"Articles","previous_headings":"","what":"Theming","title":"Customise your site","text":"two ways change visual style site _pkgdown.yml: using pre-packaged bootswatch theme customising theme variables bslib. following sections show .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"bootswatch-themes","dir":"Articles","previous_headings":"Theming","what":"Bootswatch themes","title":"Customise your site","text":"easiest way change entire appearance website use Bootswatch theme: Changing bootswatch theme affects HTML (via navbar, ) CSS, ’ll need re-build complete site build_site() fully appreciate changes. ’re experimenting, can speed things just rebuilding home page CSS running build_home_index(); init_site() (refreshing browser). Bootswatch templates tall navbars (e.g. lux, pulse) also require set pkgdown-nav-height bslib variable. Bootswatch themes provided bslib R package, can also nest bootswatch field bslib field. can find correct height running $(\".navbar\").outerHeight() javascript console.","code":"template:   bootstrap: 5   bootswatch: materia template:   bootstrap: 5   bslib:     bootswatch: lux     pkgdown-nav-height: 100px"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"bslib-variables","dir":"Articles","previous_headings":"Theming","what":"bslib variables","title":"Customise your site","text":"Instead picking complete theme, can tweak fonts colours individually using bslib variables. bslib R package wraps sass, tool Boostrap uses produce CSS special language called scss. primary advantage scss CSS ’s programmable, can key bslib variables affect appearance many HTML elements. three key variables affect colour: bg (background) determines page background. fg (foreground) determines text colour. bg fg mixed yield gray-100, gray-200, …, grey-900, used style elements match overall colour scheme. primary sets link colour (translucent) hover colour navbar sidebar. can customise components setting specific bslib variables, taking advantage inheritance possible. example, table-border-color defaults border-color defaults gray-300. want change colour borders, can set border-color; just want change colour table borders, can set table-border-color. can find full list variables vignette(\"bs5-variables\", package = \"bslib\"). can also override default fonts used majority text (base_font), headings (heading_font) code (code_font). easiest way supply name Google font: iterating colours variables need rerun init_site() refresh browser; iterating fonts, ’ll need run build_home_index(); init_site(). Theming bslib powered bslib::bs_theme() bslib field direct translation arguments function. result, can fully specify bslib theme using template.bslib field, making easy share YAML output.html_document.theme field R Markdown document.","code":"template:   bootstrap: 5   bslib:     bg: \"#202123\"     fg: \"#B8BCC2\"     primary: \"#306cc9\" template:   bootstrap: 5   bslib:     base_font: {google: \"Roboto\"}     heading_font: {google: \"Roboto Slab\"}     code_font: {google: \"JetBrains Mono\"} template:   bslib:     version: 5     bootswatch: lux     base_font: {google: \"Roboto\"}     heading_font: {google: \"Roboto Slab\"}     code_font: {google: \"JetBrains Mono\"}"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"syntax-highlighting","dir":"Articles","previous_headings":"Theming","what":"Syntax highlighting","title":"Customise your site","text":"colours used syntax highlighting code blocks controlled theme setting: can choose following options: a11y-dark, a11y-light, arrow-dark, arrow-light, atom-one-dark, atom-one-light, ayu-dark, ayu-light, ayu-mirage, breeze-dark, breeze-light, breezedark, dracula, espresso, github-dark, github-light, gruvbox-dark, gruvbox-light, haddock, kate, monochrome-dark, monochrome-light, monochrome, monokai, nord, oblivion, printing, pygments, radical, solarized-dark, solarized-light, solarized, tango, vim-dark, zenburn. Bootswatch themes dark background (e.g. cyborg, darkly, solar) need dark syntax highlighting theme, e.g. arrow-dark: foreground background colours used inline code controlled code-color code-bg bslib variables. want inline code match code blocks, ’ll need override variables , e.g.:","code":"template:   bootstrap: 5   theme: breeze-light template:   bootstrap: 5   bootswatch: cyborg   theme: arrow-dark template:    bootstrap: 5   theme: arrow-dark     bslib:     code-bg: \"#2b2b2b\""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"navbar-style","dir":"Articles","previous_headings":"Theming","what":"Navbar style","title":"Customise your site","text":"primary navbar colours determined HTML classes, CSS, can customized using navbar fields bg type control background foreground colours respectively. Typically bg one light, dark, primary: generally don’t need set bg use bootswatch theme, pkgdown pick bg used Bootstwatch preview. Similarly, don’t usually need set type bootstrap guess . guesses wrong, override type: light type: dark depending whether background colour light (need dark text) type: dark background dark (need light text). Unfortunately, defined relative page background, dark site ’ll need flip light dark (little experimentation quickly determine looks best). navbar styled HTML, ’ll need build_home_index(); init_site() see effect changing parameter.","code":"navbar:   bg: primary"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"layout","dir":"Articles","previous_headings":"","what":"Layout","title":"Customise your site","text":"can customise contents navbar, footer, home page sidebar using navbar, footer, sidebar fields. use similar structure separately defines overall structure individual components.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"navbar-heading","dir":"Articles","previous_headings":"Layout","what":"Navbar","title":"Customise your site","text":"can customise navigation bar appears top page navbar field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: makes use six built-components: intro: “Get Started”, links vignette article name package1. reference, .Rd files. articles, vignettes articles. tutorials, tutorials. news, NEWS.md exists. search, search box (see vignette(\"search\") details). github, link source repository (icon), can automatically determined DESCRIPTION. can use structure field reorganise navbar without changing default contents: can use components override default content. example, yaml provides custom articles menu: Components uses syntax RMarkdown menus. elements menu can : link (text + href) heading (just text) separator (text: ——–) Instead text, can also use name icons fontawesome. also provide textual description aria-label field screenreader users. add new component navbar, need modify structure components. example, following yaml adds new “twitter” component appears left github icon. Finally, can add arbitrary HTML three locations navbar: includes appear screen sizes, collapsed navbar drop . can also customise colour scheme navbar using type bg parameters. See details.","code":"navbar:   structure:     left:  [intro, reference, articles, tutorials, news]     right: [search, github] navbar:   structure:     left:  [search]     right: [reference, articles] navbar:  components:    articles:     text: Articles     menu:     - text: Category A     - text: Title A1       href: articles/a1.html     - text: Title A2       href: articles/a2.html     - text: -------     - text: \"Category B\"     - text: Article B1       href: articles/b1.html navbar:   structure:     right: [twitter, github]   components:     twitter:       icon: fa-twitter       href: http://twitter.com/hadleywickham       aria-label: Twitter template:   includes:     before_title: <!-- inserted before the package title in the header ->     before_navbar: <!-- inserted before the navbar links -->     after_navbar: <!-- inserted after the navbar links -->"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"footer","dir":"Articles","previous_headings":"Layout","what":"Footer","title":"Customise your site","text":"can customise footer footer field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: uses two three built-components: developed_by, sentence describing main authors package. (See ?build_home want tweak authors appear footer.) built_with, sentence advertising pkgdown. package, name package. can override defaults footer field. example puts authors’ information right along legal disclaimer, puts pkgdown link left. side pasted single string (separated \" \") converted markdown HTML.","code":"footer:   structure:      left: developed_by     right: built_with footer:   structure:      left: pkgdown     right: [developed_by, legal]   components:     legal: Provided without **any warranty**."},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"sidebar","dir":"Articles","previous_headings":"Layout","what":"Sidebar","title":"Customise your site","text":"can customise homepage sidebar home.sidebar field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: drawn seven built-components: links: automated links generated URL BugReports fields DESCRIPTION plus manual links home.links field: license: Licensing information LICENSE/LICENCE LICENSE.md/LICENCE.md files present. community: links .github/CONTRIBUTING.md, .github/CODE_OF_CONDUCT.md, etc. citation: link package citation information. Uses either inst/CITATION , absent, information DESCRIPTION. authors: selected authors DESCRIPTION. dev: development status badges extracted README.md/index.md. shown “development” versions websites; see “Development mode” ?build_site details. toc: table contents README (shown default). can also add components, text markdown text: Alternatively, can provide ready-made sidebar HTML: completely remove :","code":"home:   sidebar:     structure: [links, license, community, citation, authors, dev] home:   links:   - text: Link text     href: https://website.com   - text: Roadmap     href: /roadmap.html home:   sidebar:     structure: [authors, custom, toc, dev]     components:       custom:         title: Funding         text: We are *grateful* for funding! home:   sidebar:     html: path-to-sidebar.html home:   sidebar: FALSE"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"additional-html-and-files","dir":"Articles","previous_headings":"","what":"Additional HTML and files","title":"Customise your site","text":"need include additional HTML, can add following locations: can include additional files putting right place: pkgdown/extra.css pkgdown/extra.js copied rendered site linked <head> (pkgdown defaults). pkgdown/extra.scss added scss ruleset used generate site CSS. files pkgdown/assets copied website root directory. expert users: template files pkgdown/templates override layout templates provided pkgdown template packages. Use init_site() update rendered website making changes files.","code":"template:   includes:     in_header: <!-- inserted at the end of the head -->     before_body: <!-- inserted at the beginning of the body -->     after_body: <!-- inserted at the end of the body -->     before_title: <!-- inserted before the package title in the header ->     before_navbar: <!-- inserted before the navbar links -->     after_navbar: <!-- inserted after the navbar links -->"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"template-packages","dir":"Articles","previous_headings":"","what":"Template packages","title":"Customise your site","text":"share pkgdown style across several packages, best workflow create… package! can contain following: configuration file inst/pkgdown/_pkgdown.yml. can used set (e.g.) author definitions, Bootstrap version variables, sidebar, footer, navbar, etc. Templates inst/pkgdown/templates/ override default templates. Assets inst/pkgdown/assets/ copied destination directory. inst/pkgdown/extra.scss added bslib ruleset. configuration/files supplied override pkgdown defaults, overridden site specific settings. created template package theverybest, can use : Setting sites theme: ’re building site using GitHub actions similar tool, ’ll also need installed theverybest. ’re using r-lib pkgdown workflow, can add following line DESCRIPTION: get sense theming package works, can look : tidytemplate used tidyverse tidymodels packages; quillt used R Markdown packages; rotemplate used rOpenSci packages. please note templates aren’t suitable use package ’re designed give common visual identity specific family packages.","code":"template:   package: theverybest Config/Needs/website: theverybest"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"porting-a-template-package","dir":"Articles","previous_headings":"Template packages","what":"Porting a template package","title":"Customise your site","text":"updating template package works pkgdown 1.0.0, create directories inst/pkgdown/BS5/templates inst/pkgdown/BS5/assets (don’t templates/assets make sure add dummy file ensure git tracks ). templates assets directories directly inst/pkgdown used pkgdown 1.0.0 pkgdown 2.0.0 boostrap: 3. directories inst/pkgdown/BS5/ used pkgdown 2.0.0 boostrap: 5. lets package support versions bootstrap pkgdown.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"pr-previews","dir":"Articles","previous_headings":"","what":"PR previews","title":"Customise your site","text":"Lastly, might useful get preview website internal pull requests. , use Netlify GitHub Actions (apply similar logic toolset): Create new Netlify website (either scratch dragging dropping simple index.html, creating site GitHub repository unlinking repository); site settings get ID saved NETLIFY_SITE_ID repo secrets; account developer settings get token saved NETLIFY_AUTH_TOKEN repo secrets. Starting standard pkgdown workflow usethis::use_github_action(\"pkgdown\"), add logic build site deploy Netlify pull requests inside repository, pull requests forks. Example workflow.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"conclusion","dir":"Articles","previous_headings":"","what":"Conclusion","title":"Customise your site","text":"vignette explained change theming layout pkgdown websites. work improve user experience involve: Working article (?build_articles) reference indexes (?build_reference). Writing compelling README explains package cool/useful/fun. Improving contents individual articles reference topics 😉.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"process","dir":"Articles","previous_headings":"","what":"Process","title":"How to update a released site","text":"’re speed basic idea just want code follow, . Otherwise, read .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"setup","dir":"Articles","previous_headings":"Process","what":"Setup","title":"How to update a released site","text":"First, make sure ’re main branch, latest version: Next figure released version ’re updating: ’ll use create checkout branch ’ll work :","code":"gert::git_branch_checkout(\"main\") gert::git_pull() ver <- desc::desc_get_version()[1, 1:3] gert::git_branch_create(paste0(\"pkgdown-v\", ver), paste0(\"v\", ver))"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"backport-changes","dir":"Articles","previous_headings":"Process","what":"Backport changes","title":"How to update a released site","text":"Now need backport changes dev site branch. Run R code generate git code pull changes common locations: backport DESCRIPTION, ’ll also need undo change Version: Now build site locally check looks expect:","code":"files <- c(   # overall site config    \"_pkgdown.yml\",   # the workflow that builds the site   \".github/workflows/pkgdown.yaml\",   # readme and vignettes   \"README.md\", \"vignettes\",   # logo and favicon   \"man/figures/\", \"pkgdown/\",    # Author metadata and Config/Needs/Website   \"DESCRIPTION\" )  glue::glue(\"git checkout v{ver} -- {files}\") desc::desc_set_version(ver) pkgdown::build_site()"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"publish","dir":"Articles","previous_headings":"Process","what":"Publish","title":"How to update a released site","text":"Now need publish site. First push branch GitHub: trigger pkgdown workflow: Go package’s GHA page, e.g. usethis::browse_github_actions()). Select pkgdown workflow. Click Run workflow select branch just pushed. ’s dropdown menu , means pkgdown workflow config current.","code":"usethis:::git_push_first()"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"context","dir":"Articles","previous_headings":"","what":"Context","title":"How to update a released site","text":"talk update released site, first establish might need . released site? kind pkgdown site ? updating released site take special effort?","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"automatic-development-mode","dir":"Articles","previous_headings":"Context","what":"Automatic development mode","title":"How to update a released site","text":"Every pkgdown site -called development mode, can specified via development field _pkgdown.yml. unspecified, default mode: release, results single pkgdown site. Despite name, single site reflects “current package state”, either released state development state. packages substantial user base, recommended instead specify mode: auto like : directs pkgdown “generate different sites development released versions package.” readr package demonstrates happens automatic development mode: readr.tidyverse.org documents released version, .e. install.packages() deliver.readr.tidyverse.org/dev/ documents dev version, .e. ’d get installing GitHub. mode, pkgdown::build_site(), consults DESCRIPTION learn package’s version number. development version number, rendered site written docs/dev/. released version number, site written docs/. (also signals alert users reading documentation dev version vs. released version.) Automatic development mode recommended packages broad user base, maximizes chance user read web-based documentation reflects package version locally installed.","code":"development:   mode: auto"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"publishing","dir":"Articles","previous_headings":"Context","what":"Publishing","title":"How to update a released site","text":"Now ’ve established meaning released (vs dev) site, consider site built (.e. HTML generated) deployed (.e. HTML published website people can see .). recommend usethis::use_pkgdown_github_pages() basic pkgdown setup configure GitHub Actions (GHA) workflow automatically render publish site GitHub Pages. function bascially shortcut calling following functions individually: use_pkgdown() use_github_pages() use_github_action(\"pkgdown\") adds pkgdown site’s URL _pkgdown.yml, URL field DESCRIPTION, GitHub repo. result, publishing cadence many pkgdown sites governed workflow maintained r-lib/actions/examples/pkgdown.yaml. (confuse _pkgdown.yml, gives instructions pkgdown package, .github/workflows/pkgdown.yaml, gives instructions GHA.) important bits GHA workflow config: Altogether means : Build deploy pushes main. Build, don’t deploy, pull requests main. reveals pkgdown errors, ensures live site isn’t updated pull request merged (code pushed main). Build deploy publish GitHub release. convention, assume GitHub release coincides CRAN release. primary mechanism building released pkgdown site. pkgdown::build_site_github_pages() consults version DESCRIPTION detect whether ’s building released version dev version. determines dest_dir, e.g. docs/ released docs/dev/ dev. package automatic development mode, means almost pushes trigger update dev site. released site updated push state non-development version number publish GitHub release. tweak things released site releases? brings us workflow_dispatch:. (Yes dangling colon correct.) inclusion workflow_dispatch trigger means pkgdown workflow can run demand, importantly browser.","code":"on:   push:     branches: [main, master]   pull_request:     branches: [main, master]   release:     types: [published]   workflow_dispatch:    <snip, snip>        - name: Build site         run: Rscript -e 'pkgdown::build_site_github_pages(...)'                - name: Deploy to GitHub pages 🚀         if: github.event_name != 'pull_request'         uses: JamesIves/github-pages-deploy-action@4.1.4                  <snip, snip>"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"construct-a-branch-for-the-update","dir":"Articles","previous_headings":"","what":"Construct a branch for the update","title":"How to update a released site","text":"overall goal create branch combines features released website (e.g. released version) development version (e.g. improvements _pkgdown.yml). easiest way start branch using latest release tag, bring selected changes files development version. example, readr’s latest release 2.1.1: general pattern: Now port innovations development site want apply released site. Files must update: .github/workflows/pkgdown.yaml _pkgdown.yml Config/Needs/website field DESCRIPTION (, probably, field! particular, mess version number.) likely candidates: README.Rmd + README.md, e.g., ’ve updated badges. documentation fixes apply released version. reason touch anything R/ even affect roxygen comments. Don’t forget document() ! new vignettes articles apply released version. tips backporting specific changes branch. lucky, specific commits default branch contain necessary changes. case, can cherry pick commit SHA: doesn’t cover everything, file want update, identify Git reference (meaning: SHA, tag, branch) file desired state. Checkout specific file path specific ref: example, readr recently gained new vignette applies released version readr, .e. document dev-features functions. can bring current branch : Commit push new branch GitHub. usethis::pr_push() can handy . Just don’t bother opening pull request (branch still pushed). Now use workflow_dispatch GHA trigger: Go Actions page repo, maybe via usethis::browse_github_actions(). Click pkgdown workflow. Click “Run workflow”. “Use workflow ” dropdown menu, select branch ’ve just made pushed, click “Run workflow”. kick pkgdown build--deploy , specifically, cause updates released site. can keep branch around , case didn’t get everything right first time things crop ’d like backport released site, next CRAN release.","code":"git checkout -b update-pkgdown-2-1-1 v2.1.1 git checkout -b NEW-BRANCH-NAME NAME-OF-RELEASE-TAG git cherry-pick SHA git checkout main -- path/to/the/file git checkout main -- vignettes/column-types.Rmd"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"problem-solving","dir":"Articles","previous_headings":"","what":"Problem-solving","title":"How to update a released site","text":"Another great problem solving technique get bunch people’s _pkgdown.yml files front eyeballs. two ways : GitHub search Michael Chirico’s r-ci-samples repo. given _pkgdown.yml file, remember History Blame can helpful seeing evolved time.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/linking.html","id":"within-a-package","dir":"Articles","previous_headings":"","what":"Within a package","title":"Auto-linking","text":"pkgdown automatically link documentation articles wherever ’s possible unambiguously. includes: Bare function calls, like build_site(). Calls ?, like ?build_site package?pkgdown. Calls help(), like help(\"pkgdown\"). Calls vignette(), like vignette(\"pkgdown\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/linking.html","id":"across-packages","dir":"Articles","previous_headings":"","what":"Across packages","title":"Auto-linking","text":"Linking documentation another package straightforward. Just adapt call usual way: purrr::map(), MASS::addterm(). ?purrr::map, ?MASS::addterm. vignette(\"-langs\", package = \"purrr\"), vignette(\"longintro\", package = \"rpart\") purrr pkgdown can find pkgdown site remote package, link ; otherwise, link https://rdrr.io/ documentation CRAN vignettes. order pkgdown site findable, needs listed two places: URL field DESCRIPTION, dplyr: url field _pkgdown.yml, dplyr field defined, pkgdown generate public facing pkgdown.yml file provides metadata site: Now, build pkgdown site package links dplyr documentation (e.g., dplyr::mutate()), pkgdown looks first dplyr’s DESCRIPTION find website, looks pkgdown.yml, uses metadata generate correct links. allow package linked locally installed packages, even website reachable build time, following option needs set _pkgdown.yml: allows locally installed packages access package index metadata locally installed copy, may useful website require auth, build behind firewall.","code":"URL: https://dplyr.tidyverse.org, https://github.com/tidyverse/dplyr url: https://dplyr.tidyverse.org pandoc: '2.2' pkgdown: 1.3.0 pkgdown_sha: ~ articles:   compatibility: compatibility.html   dplyr: dplyr.html   dplyr_0.8.0: future/dplyr_0.8.0.html   dplyr_0.8.0_new_hybrid: future/dplyr_0.8.0_new_hybrid.html   programming: programming.html   two-table: two-table.html   window-functions: window-functions.html urls:   reference: https://dplyr.tidyverse.org/reference   article: https://dplyr.tidyverse.org/articles deploy:   install_metadata: true"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"necessary-configuration","dir":"Articles","previous_headings":"","what":"Necessary configuration","title":"Metadata","text":"Metadata can produced correctly pkgdown website URL indicated configuration file.","code":"url: https://example.com"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"site-wide-customization","dir":"Articles","previous_headings":"","what":"Site-wide customization","title":"Metadata","text":"Metadata entire pkgdown website can specified site’s _pkgdown.yml configuration file home template: opengraph sections: home: title home: description fields override Title Description fields package DESCRIPTION. ’s good practice set fields make package documentation easier find via search, rather sticking title description needed CRAN. template: opengraph section allows customize social media card. image: default, pkgdown uses package’s logo card image (one exists). Use image specify alternative image social media cards pages pkgdown site. src: fully qualified URL media card image e.g. src: https://avatars.githubusercontent.com/u/22618716?v=4; relative path image rendered website e.g. src: articles/test/image.jpg; relative path image stored man/figures package e.g. src: man/figures/cards.png. src field required image specified. alt: Alternative text describing image screen readers situations social media card image displayed. twitter: can specify Twitter accounts associated package style social media card Twitter display. creator: Typically, Twitter handle author package article. site: Twitter handle organization affiliated package author sponsoring package development. one creator site included, provided value used fields. card: style social media card Twitter display. pkgdown sites, relevant options summary_large_image, featuring large image page title description, summary, featuring small square image inline left page title description.","code":"home:   title: An R package for pool-noodle discovery   description: Discover and add pool-noodles to your growing collection.    template:   opengraph:     image:       src: man/figures/card.png       alt: \"Pool noodles configured to form the word poolnoodlr\"     twitter:       creator: \"@hadleywickham\"       site: \"@rstudio\"       card: summary_large_image"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"article-metadata","dir":"Articles","previous_headings":"","what":"Article metadata","title":"Metadata","text":"Articles vignettes rendered articles pkgdown can individually customized metadata social media cards. Use title, description, author fields specify title, description, (optional) author vignette article. title field used title article pkgdown site always included. title description used pkgdown page’s social media card. description included article’s YAML front matter, name package used instead. description also displayed articles index. author field used text vignette article. author name displayed depends output format. articles, opengraph section works way site-wide template: opengraph settings, applied article vignette. allows specify social media card preview images individual articles, associate article particular Twitter account. specified, opengraph settings site-wide configuration used.","code":"title: \"Introduction to poolnoodlr\" description: \"A brief introduction to pool noodles in R.\" author: \"Mara Averick\" opengraph:   image:      src: \"https://example.com/pkg/batpig.png\"   twitter:     card: summary     creator: \"@dataandme\" output: rmarkdown::html_vignette vignette: >   %\\VignetteIndexEntry{Introduction to poolnoodlr}   %\\VignetteEngine{knitr::rmarkdown}   %\\VignetteEncoding{UTF-8}"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"metadata","dir":"Articles","previous_headings":"","what":"Metadata","title":"Introduction to pkgdown","text":"can override pkgdown’s defaults YAML file called _pkgdown.yml1. important field url, gives final location site: url used throughout site generate absolute urls needed. url also part enables auto-links help topics vignettes sites external package, pkgdown sites Quarto websites. See vignette(\"linking\") . Another important option template, allows control overall appearance site: can learn controlling appearance site vignette(\"customise\").","code":"url: https://pkgdown.r-lib.org template:   bootstrap: 5   bootswatch: cerulean"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"language","dir":"Articles","previous_headings":"Metadata","what":"Language","title":"Introduction to pkgdown","text":"documentation (.Rd .Rmd) written language English, declare setting setting lang two letter language code language: used set language web page translate English words pkgdown generates site. Current available translations : ca: Catalan de: German dk: Danish es: Spanish fr: French ko: Korean pt: Portuguese tr: Turkish zh_CN: Chinese (simplified)","code":"lang: fr"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"home-page","dir":"Articles","previous_headings":"","what":"Home page","title":"Introduction to pkgdown","text":"contents home page automatically generated index.md README.md. pkgdown tries order, ’s possible different display GitHub pkgdown providing files. homepage also includes sidebar full useful links; see ?build_home generated can customise .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"reference","dir":"Articles","previous_headings":"","what":"Reference","title":"Introduction to pkgdown","text":"pkgdown creates function reference reference/ includes one page .Rd help topic man/. translation individual help topics Rd HTML generally straightforward, couple things bear mind: pkgdown best autolink references help topics articles described vignette(\"linking\"). pkgdown executes examples, inserting rendered results generated HTML files. default, pkgdown generates reference index just alphabetically-ordered list functions. index much useful human curation functions can grouped described categories. override default, provide reference field _pkgdown.yml. entry reference can take one three forms: title, defined title optional desc (description) fields. subtitle, defined subtitle optional desc (description) fields. list topics defined contents field. Note use starts_with() select functions common prefix. can also use ends_with() matches(). See complete details ?build_reference. iterating reference index might want run pkgdown::build_reference_index(). just re-builds index page, making faster quickly change _pkgdown.yml see affects site.","code":"reference: - title: \"Connecting to Spark\"   desc: >     Functions for installing Spark components and managing     connections to Spark   contents:    - spark_config   - spark_connect   - spark_disconnect   - spark_install   - spark_log - title: \"Reading and Writing Data\"   desc: \"Functions for reading and writing Spark DataFrames.\"   contents:   - starts_with(\"spark_read\")   - starts_with(\"spark_write\")   - matches(\"saveload\")"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"articles","dir":"Articles","previous_headings":"","what":"Articles","title":"Introduction to pkgdown","text":"pkgdown automatically build vignettes found vignettes/, translating HTML files articles/. Due way pkgdown integrate RMarkdown generated HTML HTML, relatively little control available output format. can see details ?build_articles. want include article website package (e.g., ’s large), can either place subdirectory vignettes/ (e.g. vignettes/web_only) add .Rbuildignore (make sure ’s vignettes: section yaml header). extreme case want produce articles vignettes, add complete vignettes/ directory .Rbuildignore ensure DESCRIPTION VignetteBuilder field.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"news","dir":"Articles","previous_headings":"","what":"News","title":"Introduction to pkgdown","text":"NEWS.md present, rendered single-page changelog based markdown level headings. pkgdown assumes NEWS.md formatted using level one headings (#) specify package name version number, level two headings (##) provide topical organization release. See suggestions writing news bullets tidyverse style guide. See ?build_news customisation options including : Create one page major version related minor versions. Add release announcements news navbar drop-.","code":"# pkgdown 1.1.0  ## Bug Fixes  * Lots of them  # pkgdown 1.0.0  * This is the first release of pkgdown."},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"publishing","dir":"Articles","previous_headings":"","what":"Publishing","title":"Introduction to pkgdown","text":"use GitHub, two ways publish site GitHub Pages: Build site locally, check docs directory, configure GitHub Pages use directory. Use GitHub actions automatically build publish site every time make change. easiest way set run usethis::use_pkgdown_github_pages().","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"promoting","dir":"Articles","previous_headings":"","what":"Promoting","title":"Introduction to pkgdown","text":"finalized site built published web, publicize URL places: URL field package DESCRIPTION, alongside link source: (usethis::use_pkgdown_github_pages() .) repository description GitHub. (usethis::use_pkgdown_github_pages() .) Twitter (make sure include #rstats).","code":"URL: https://pkgdown.r-lib.org, https://github.com/r-lib/pkgdown"},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"bootstrap-5-built-in-search","dir":"Articles","previous_headings":"","what":"Bootstrap 5: built-in search","title":"Search","text":"BS5, search built-building pkgdown website automatically build search index ’s available navbar (using fuse.js). Currently available customisation excluding paths search index: Note search requires “real” server, local file:// based preview, search won’t work default preview. test search local preview, ’ll need use servr::httw(\"docs\") similar.","code":"search:   exclude: ['news/index.html']"},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"bootstrap-3-algolia","dir":"Articles","previous_headings":"","what":"Bootstrap 3: Algolia","title":"Search","text":"pkgdown websites can integrate search capability using DocSearch Algolia. DocSearch powerful search engine free documentation websites. two steps needed enable DocSearch pkgdown website.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"indexing","dir":"Articles","previous_headings":"Bootstrap 3: Algolia","what":"Indexing","title":"Search","text":"published pkgdown website, submit pkgdown site URL Docsearch. Docsearch contact via e-mail confirm website owner. Docsearch set crawler configuration indexes site every 24 hours. pkgdown builds suggested Docsearch crawler configuration docsearch.json point Docsearch team configuration starting point. want optimize search, Docsearch accept pull requests configuration incorporate additional options fine tune scraping.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"configuration","dir":"Articles","previous_headings":"Bootstrap 3: Algolia","what":"Configuration","title":"Search","text":"Docsearch team e-mail JavaScript integrate website. Put value apiKey indexName parameters site _pkgdown.yml template: params: also need add url: field _pkgdown.yml specifies location documentation web. pkgdown, URL field : building custom Docsearch index, can also include Docsearch app_id _pkgdown.yml. See pkgdown configuration functional search configuration. configuration complete, find search bar re-building site. search enabled, pressing shift + / (.e., “?”) move focus search bar.","code":"<script type=\"text/javascript\">   docsearch({      apiKey: 'API_KEY',  // a long hex string     indexName: 'INDEX_NAME',      inputSelector: '### REPLACE ME ####',      debug: false // Set debug to true if you want to inspect the dropdown  }); template:   params:     docsearch:       api_key: API_KEY       index_name: INDEX_NAME url: https://pkgdown.r-lib.org"},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"footnotes","dir":"Articles > Test","previous_headings":"","what":"Footnotes","title":"Output Rendering","text":"Yay1","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"figures","dir":"Articles > Test","previous_headings":"","what":"Figures","title":"Output Rendering","text":"","code":"plot(1:10)"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"external-files","dir":"Articles > Test","previous_headings":"","what":"External files","title":"Output Rendering","text":"","code":"x <- readLines(\"test.txt\") x #> [1] \"a\" \"b\" \"c\" \"d\""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"details-tag","dir":"Articles > Test","previous_headings":"","what":"Details tag","title":"Output Rendering","text":"First paragraph","code":"1 + 2 #> [1] 3"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"mathjax","dir":"Articles > Test","previous_headings":"","what":"Mathjax","title":"Output Rendering","text":"\\[f(x) = \\dfrac{1}{\\sqrt{2\\pi\\sigma^2}} e^{-\\frac{(x-\\mu^2)}{2\\sigma^2}}\\] Inline equations: \\(y=x^2\\)","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"line-width","dir":"Articles > Test","previous_headings":"Code","what":"Line width","title":"Output Rendering","text":"","code":"pkgdown:::ruler() #> ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 #> 12345678901234567890123456789012345678901234567890123456789012345678901234567890  cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"should-be-highlighted","dir":"Articles > Test","previous_headings":"Code","what":"Should be highlighted","title":"Output Rendering","text":"Valid R code \\preformatted{}: R code R block: R code r block: Yaml","code":"mean(a + 1) mean(a + 1) mean(a + 1) yaml: [a, 1]"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"shouldnt-be-highlighted","dir":"Articles > Test","previous_headings":"Code","what":"Shouldn’t be highlighted","title":"Output Rendering","text":"Non-R code \\preformatted{}","code":"yaml: [a, b, c]"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"crayon","dir":"Articles > Test","previous_headings":"Code","what":"Crayon","title":"Output Rendering","text":"text text","code":"cat(cli::col_red(\"This is red\"), \"\\n\") #> This is red cat(cli::col_blue(\"This is blue\\n\"), \"\\n\") #> This is blue #>   message(cli::col_green(\"This is green\")) #> This is green  warning(cli::style_bold(\"This is bold\")) #> Warning: This is bold stop(cli::style_italic(\"This is italic\")) #> Error in eval(expr, envir, enclos): This is italic"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"quoted-text","dir":"Articles > Test","previous_headings":"","what":"Quoted text","title":"Output Rendering","text":"Single-line quote something miscellaneous. Flush  1 space indent   2 space indent    3 space indent","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"this-section-is-unnumbered","dir":"Articles > Test","previous_headings":"","what":"This section is unnumbered","title":"Output Rendering","text":"however bug !","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"tabset-with-pills","dir":"Articles > Test","previous_headings":"Tabsets","what":"Tabset with pills","title":"Output Rendering","text":"Tab 1 Tab 2 blablablabla “cool” heading blop","code":"1 + 1"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"cool","dir":"Articles > Test","previous_headings":"Tabsets > Tabset with pills","what":"cool","title":"Output Rendering","text":"Stuff","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"tabset-without-pills","dir":"Articles > Test","previous_headings":"Tabsets","what":"Tabset without pills","title":"Output Rendering","text":"Tab 1 Tab 2 something nice  tab active","code":"plot(1:42)"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"fading-tabset","dir":"Articles > Test","previous_headings":"Tabsets","what":"Fading tabset","title":"Output Rendering","text":"English French German Hello! Bonjour! Guten tag.","code":""},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/widgets.html","id":"widgets","dir":"Articles > Test","previous_headings":"","what":"Widgets","title":"HTML widgets","text":"Test spacing widget. Test spacing widget.","code":""},{"path":"https://pkgdown.r-lib.org/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Hadley Wickham. Author, maintainer. Jay Hesselberth. Author. Maëlle Salmon. Author. . Copyright holder, funder.","code":""},{"path":"https://pkgdown.r-lib.org/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Wickham H, Hesselberth J, Salmon M (2024). pkgdown: Make Static HTML Documentation Package. R package version 2.0.8.9000, https://github.com/r-lib/pkgdown, https://pkgdown.r-lib.org.","code":"@Manual{,   title = {pkgdown: Make Static HTML Documentation for a Package},   author = {Hadley Wickham and Jay Hesselberth and Maëlle Salmon},   year = {2024},   note = {R package version 2.0.8.9000, https://github.com/r-lib/pkgdown},   url = {https://pkgdown.r-lib.org}, }"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"pkgdown-","dir":"","previous_headings":"","what":"Build websites for R packages","title":"Build websites for R packages","text":"pkgdown designed make quick easy build website package. can see pkgdown action https://pkgdown.r-lib.org: output pkgdown applied latest version pkgdown. Learn vignette(\"pkgdown\") ?build_site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Build websites for R packages","text":"","code":"# Install development version from GitHub # install.packages(\"pak\") pak::pak(\"r-lib/pkgdown\")"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Build websites for R packages","text":"Get started usethis: use pkgdown build website: generates docs/ directory containing website. README.md becomes homepage, documentation man/ generates function reference, vignettes rendered articles/. Read vignette(\"pkgdown\") details, learn deploy site GitHub pages.","code":"# Run once to configure your package to use pkgdown usethis::use_pkgdown() pkgdown::build_site()"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"pkgdown-200-and-bootstrap-5","dir":"","previous_headings":"Usage","what":"pkgdown 2.0.0 and Bootstrap 5","title":"Build websites for R packages","text":"pkgdown 2.0.0 includes upgrade Bootstrap 3 Bootstrap 5, accompanied whole bunch minor UI improvements. ’ve heavily customised site, ’s small chance break site, everyone needs explicitly opt-upgrade adding following _pkgdown.yml: learn many new ways customise site vignette(\"customise\").","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"in-the-wild","dir":"","previous_headings":"","what":"In the wild","title":"Build websites for R packages","text":"last count, pkgdown used 11,000 packages. examples created contributors pkgdown: bayesplot (source): plotting functions posterior analysis, model checking, MCMC diagnostics. valr (source): read manipulate genome intervals signals. mkin (source): calculation routines based FOCUS Kinetics Report NMF (source): framework perform non-negative matrix factorization (NMF). Comparing source output sites great way learn new pkgdown techniques.","code":""},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of conduct","title":"Build websites for R packages","text":"Please note project released Contributor Code Conduct. participating project agree abide terms.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate pkgdown data structure — as_pkgdown","title":"Generate pkgdown data structure — as_pkgdown","text":"generally need use unless need custom site design writing equivalent build_site().","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate pkgdown data structure — as_pkgdown","text":"","code":"as_pkgdown(pkg = \".\", override = list())"},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate pkgdown data structure — as_pkgdown","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatically link references and articles in an HTML page — autolink_html","title":"Automatically link references and articles in an HTML page — autolink_html","text":"Deprecated: please use downlit::downlit_html_path instead.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatically link references and articles in an HTML page — autolink_html","text":"","code":"autolink_html(input, output = input, local_packages = character())"},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatically link references and articles in an HTML page — autolink_html","text":"input, output Input output paths HTML file local_packages named character vector providing relative paths (value) packages (name) can reached relative links target HTML document.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatically link references and articles in an HTML page — autolink_html","text":"","code":"if (FALSE) { autolink_html(\"path/to/file.html\",   local_packages = c(     shiny = \"shiny\",     shinydashboard = \"shinydashboard\"   ) ) }"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":null,"dir":"Reference","previous_headings":"","what":"Build articles section — build_articles","title":"Build articles section — build_articles","text":"build_articles() renders R Markdown file underneath vignettes/ saves articles/. two exceptions: Files start _ (e.g., _index.Rmd) ignored, enabling use child documents. Files vignettes/tutorials handled build_tutorials() Vignettes rendered using special document format reconciles rmarkdown::html_document() pkgdown template. means articles behave slightly differently vignettes, particularly respect external files, custom output formats. See details. Note run build_articles() directly (outside build_site()) vignettes use currently installed version package, current source version. makes iteration quicker primarily working text article.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build articles section — build_articles","text":"","code":"build_articles(   pkg = \".\",   quiet = TRUE,   lazy = TRUE,   seed = 1014L,   override = list(),   preview = NA )  build_article(   name,   pkg = \".\",   data = list(),   lazy = FALSE,   seed = 1014L,   new_process = TRUE,   quiet = TRUE )  build_articles_index(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build articles section — build_articles","text":"pkg Path package. quiet Set FALSE display output knitr pandoc. useful debugging. lazy TRUE, re-build article input file modified recently output file. seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. name Name article render. either path relative vignettes/ without extension, index README. data Additional data pass template. new_process Build article clean R process? default, TRUE, ensures every article build fresh environment, may want set FALSE make debugging easier.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"index-and-navbar","dir":"Reference","previous_headings":"","what":"Index and navbar","title":"Build articles section — build_articles","text":"can control articles index navbar articles field _pkgdown.yml. use , pkgdown check articles included, error missed . articles field defines list sections, can contain four fields: title (required): title section, appears heading articles index. desc (optional): optional markdown description displayed underneath section title. navbar (optional): couple words used label section navbar. omitted, section vignettes appear navbar. contents (required): list article names include section. can either names individual vignettes call starts_with(). name vignette includes path vignettes without extension name vignette found vignettes/pizza/slice.Rmd pizza/slice. title description individual vignettes displayed index comes title description fields YAML header Rmds. example, yaml might used version dplyr:   Note use navbar fields. navbar: ~ means \"Main verbs\" appear navbar without heading; absence navbar field developer vignettes means accessible via articles index. navbar include link articles index one vignettes available navbar. vignettes appear navbar drop-list others , list automatically include \"...\" link bottom; vignettes appear navbar, link directly articles index instead providing drop-.","code":"articles: - title: Main verbs   navbar: ~   contents:   - one-table   - two-table   - rowwise   - colwise  - title: Developer   desc: Vignettes aimed at package developers   contents:   - programming   - packages"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"get-started","dir":"Reference","previous_headings":"","what":"Get started","title":"Build articles section — build_articles","text":"Note vignette name package (e.g., vignettes/pkgdown.Rmd vignettes/articles/pkgdown.Rmd) automatically becomes top-level \"Get started\" link, appear articles drop-. (package name includes ., e.g. pack., use - vignette name, e.g. pack-.Rmd.)","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"external-files","dir":"Reference","previous_headings":"","what":"External files","title":"Build articles section — build_articles","text":"pkgdown differs base R handling external files. building vignettes, R assumes vignettes self-contained (reasonable assumption vignettes PDFs) copies files explicitly listed .install_extras. pkgdown takes different approach based rmarkdown::find_external_resources(), also copy images link . reason automatic detection work, need add resource_files field yaml metadata, e.g.:   Note can use fig.path change output directory generated figures default value strong assumption rmarkdown.","code":"--- title: My Document resource_files:   - data/mydata.csv   - images/figure.png ---"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"embedding-shiny-apps","dir":"Reference","previous_headings":"","what":"Embedding Shiny apps","title":"Build articles section — build_articles","text":"like embed Shiny app article, app hosted independently, (e.g. https://www.shinyapps.io). , can embed app article using <iframe>, e.g. <iframe src = \"https://gallery.shinyapps.io/083-front-page\" class=\"shiny-app\">. See https://github.com/r-lib/pkgdown/issues/838#issuecomment-430473856 hints customise appearance CSS.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"output-formats","dir":"Reference","previous_headings":"","what":"Output formats","title":"Build articles section — build_articles","text":"default, pkgdown builds articles using rmarkdown::html_document() output format, ignoring whatever set YAML metadata. necessary pkgdown integrate HTML/CSS/JS vignette HTML/CSS/JS rest site. challenges combining two sources HTML/CSS/JS, limited support output formats opt-setting as_is field .Rmd metadata:   output format produces PDF, also need specify extension field:   work pkgdown, output format must accept template, theme, self_contained arguments, must work without additional CSS JSS files. Note use _output.yml _site.yml still need add as_is: true individual vignette. Additionally, htmlwidgets work as_is: true.","code":"pkgdown:   as_is: true pkgdown:   as_is: true   extension: pdf"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"suppressing-vignettes","dir":"Reference","previous_headings":"","what":"Suppressing vignettes","title":"Build articles section — build_articles","text":"want articles vignettes, either put subdirectories list .Rbuildignore. articles link automatically added default navbar vignettes directory present: want , need customise navbar. See build_site() details.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"figures","dir":"Reference","previous_headings":"","what":"Figures","title":"Build articles section — build_articles","text":"can control default rendering figures specifying figures field _pkgdown.yml. default settings equivalent :   parameters interpreted similarly knitr chunk options. .parameters list parameters available custom graphics output devices HTML widgets.","code":"figures:   dev: ragg::agg_png   dpi: 96   dev.args: []   fig.ext: png   fig.width: 7.2916667   fig.height: ~   fig.retina: 2   fig.asp: 1.618   bg: NA   other.parameters: []"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":null,"dir":"Reference","previous_headings":"","what":"Create favicons from package logo — build_favicons","title":"Create favicons from package logo — build_favicons","text":"function auto-detects location package logo (name logo.svg (recommended format) logo.png) runs https://realfavicongenerator.net API build complete set favicons different sizes, needed modern web usage.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create favicons from package logo — build_favicons","text":"","code":"build_favicons(pkg = \".\", overwrite = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create favicons from package logo — build_favicons","text":"pkg Path package. overwrite TRUE, re-create favicons package logo.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create favicons from package logo — build_favicons","text":"need run function . favicon set stored pkgdown/favicon copied init_site() relevant location website rebuilt. complete, add pkgdown/ .Rbuildignore  avoid NOTE package checking.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":null,"dir":"Reference","previous_headings":"","what":"Build home section — build_home_index","title":"Build home section — build_home_index","text":"build_home() function generates pages top-level site including: home page HTML files .md files ./ .github/. authors page (DESCRIPTION) citation page (inst/CITATION, present). license page default 404 page .github/404.md found. build_home_index() rebuilds just index page; useful rapidly iterating experimenting site styles.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build home section — build_home_index","text":"","code":"build_home_index(pkg = \".\", quiet = TRUE)  build_home(pkg = \".\", override = list(), preview = NA, quiet = TRUE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build home section — build_home_index","text":"pkg Path package. quiet Set FALSE display output knitr pandoc. useful debugging. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"home-page","dir":"Reference","previous_headings":"","what":"Home page","title":"Build home section — build_home_index","text":"main content home page (index.html) generated pkgdown/index.md, index.md, README.md, order. packages use README.md also displayed GitHub CRAN. Use index.md want package website look different README, use pkgdown/index.md want file live package root directory. use index.Rmd README.Rmd responsibility knit document create corresponding .md. pkgdown touches files doc/ directory. Extra markdown files base directory (e.g. ROADMAP.md) .github/ (e.g. CODE_OF_CONDUCT.md) copied build_home() docs/ converted HTML. home page also features sidebar information extracted package. can tweak via configuration file, help make home page informative possible landing page.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"images-and-figures","dir":"Reference","previous_headings":"","what":"Images and figures","title":"Build home section — build_home_index","text":"want include images README.md, must stored somewhere package can displayed CRAN website. best place put man/figures. generating figures R Markdown, make sure set fig.path followed:   usually go chunk include = FALSE.","code":"knitr::opts_chunk$set(   fig.path = \"man/figures/\" ) ```{r chunk-name, include=FALSE} knitr::opts_chunk$set(   fig.path = \"man/figures/\" ) ```"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"package-logo","dir":"Reference","previous_headings":"","what":"Package logo","title":"Build home section — build_home_index","text":"package logo, can include top README level-one heading:   init_site() also automatically create favicon set package logo.","code":"# pkgdown <img src=\"man/figures/logo.png\" align=\"right\" />"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"yaml-config-home","dir":"Reference","previous_headings":"","what":"YAML config - home","title":"Build home section — build_home_index","text":"tweak home page, need section configuration file called home.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"page-title-and-description","dir":"Reference","previous_headings":"","what":"Page title and description","title":"Build home section — build_home_index","text":"default, page title description extracted automatically Title Description fields DESCRIPTION (stripping single quotes quoted words). CRAN ensures fields contain phrases like \"R package\" obvious CRAN. make package findable search engines, good practice override title description, thinking people might search :   (Note use YAML's > .e. \"YAML pipes\"; convenient way writing paragraphs text.)","code":"home:   title: An R package for pool-noodle discovery   description: >     Do you love R? Do you love pool-noodles? If so, you might enjoy     using this package to automatically discover and add pool-noodles     to your growing collection."},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"readme-header","dir":"Reference","previous_headings":"","what":"README header","title":"Build home section — build_home_index","text":"READMEs usually start <h1> containing package name. feels duplicative package name navbar can remove strip_header: true:","code":"home:   strip_header: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"dev-badges","dir":"Reference","previous_headings":"","what":"Dev badges","title":"Build home section — build_home_index","text":"pkgdown identifies badges three ways: image-containing links <!-- badges: start --> <!-- badges: end -->, e.g. created usethis::use_readme_md() usethis::use_readme_rmd(). always empty line <!-- badges: end --> line. divide badges paragraphs, make sure add empty line <!-- badges: end --> line. image-containing links within <div id=\"badges\"><\/div>. Within first paragraph, contains image-containing links. Identified badges removed main content. shown sidebar depending development mode sidebar customization, see sidebar section.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"authors","dir":"Reference","previous_headings":"","what":"Authors","title":"Build home section — build_home_index","text":"default, pkgdown display author information three places: sidebar, left part side footer, author page. documentation describes customise overall author display. See ?build_home ?build_site details changing location authors information within home sidebar site footer.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"authors-orcid-and-bio","dir":"Reference","previous_headings":"","what":"Authors ORCID and bio","title":"Build home section — build_home_index","text":"Author ORCID identification numbers DESCRIPTION linked using ORCID logo:   want add details authors involvement package, can use comment field, rendered authors page.","code":"Authors@R: c(     person(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = c(\"aut\", \"cre\"),       comment = c(ORCID = \"0000-0003-4757-117X\")     ),     person(\"Jay\", \"Hesselberth\", role = \"aut\",       comment = c(ORCID = \"0000-0002-6299-179X\")     )   ) Authors@R: c(     person(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = c(\"aut\", \"cre\"),       comment = c(ORCID = \"0000-0003-4757-117X\", \"Indenter-in-chief\")     ),     person(\"Jay\", \"Hesselberth\", role = \"aut\",       comment = c(ORCID = \"0000-0002-6299-179X\")     )   )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"yaml-config-authors","dir":"Reference","previous_headings":"","what":"YAML config - authors","title":"Build home section — build_home_index","text":"can tweak things via authors YAML field: display author footer, sidebar authors page, authors (role) displayed sidebar footer, text authors footer, text authors sidebar, text authors authors page. can modify author's name displayed adding subsection authors. entry authors named author's name (matching DESCRIPTION) can contain href /html fields: href provided, author's name linked URL. html provided, shown instead author's name. particularly useful want display logo corporate sponsor. Use absolute URL image, relative link. Use empty alternative text rather alternative text screen-reader skip .   default, \"developers\" list shown sidebar footer populated maintainer (\"cre\"), authors (\"aut\"), funder (\"fnd\") DESCRIPTION. choose roles filtering. configuration : maintainer funder(s) appear footer, text \"Crafted \", authors contributors appear sidebar, authors list sidebar preceded followed text, authors list authors page preceded followed text.   want filter authors based something else roles, consider using custom sidebar/footer component (see ?build_home/?build_site, respectively).","code":"authors:   firstname lastname:     href: \"http://name-website.com\"     html: \"<img src='https://website.com/name-picture.png' width=72 alt=''>\" authors:   footer:     roles: [cre, fnd]     text: \"Crafted by\"   sidebar:     roles: [aut, ctb]     before: \"So *who* does the work?\"     after: \"Thanks all!\"   before: \"This package is proudly brought to you by:\"   after: \"See the [changelog](news/index.html) for other contributors. :pray:\""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"sidebar","dir":"Reference","previous_headings":"","what":"Sidebar","title":"Build home section — build_home_index","text":"can customise homepage sidebar home.sidebar field. made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure:   drawn seven built-components: links: automated links generated URL BugReports fields DESCRIPTION plus manual links home.links field:   license: Licensing information LICENSE/LICENCE LICENSE.md/LICENCE.md files present. community: links .github/CONTRIBUTING.md, .github/CODE_OF_CONDUCT.md, etc. citation: link package citation information. Uses either inst/CITATION , absent, information DESCRIPTION. authors: selected authors DESCRIPTION. dev: development status badges extracted README.md/index.md. shown \"development\" versions websites; see \"Development mode\" ?build_site details. toc: table contents README (shown default). can also add components, text markdown text:   Alternatively, can provide ready-made sidebar HTML:   completely remove :","code":"home:   sidebar:     structure: [links, license, community, citation, authors, dev] home:   links:   - text: Link text     href: https://website.com   - text: Roadmap     href: /roadmap.html home:   sidebar:     structure: [authors, custom, toc, dev]     components:       custom:         title: Funding         text: We are *grateful* for funding! home:   sidebar:     html: path-to-sidebar.html home:   sidebar: FALSE"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":null,"dir":"Reference","previous_headings":"","what":"Build news section — build_news","title":"Build news section — build_news","text":"NEWS.md broken versions using level one (#) level two headings (##) (partially) match one following forms (ignoring case): {package name} 1.3.0 {package name} v1.3.0 Version 1.3.0 Changes 1.3.0 Changes v1.3.0","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build news section — build_news","text":"","code":"build_news(pkg = \".\", override = list(), preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build news section — build_news","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build news section — build_news","text":"common structure news files use top level heading release, use second level heading break individual bullets sections.   Issues contributors automatically linked corresponding pages GitHub GitHub repo can discovered DESCRIPTION (typically URL entry containing github.com) version available CRAN, release date automatically added heading (see suppress); available CRAN, \"Unreleased\" added.","code":"# foofy 1.0.0  ## Major changes  * Can now work with all grooveable grobbles!  ## Minor improvements and bug fixes  * Printing scrobbles no longer errors (@githubusername, #100)  * Wibbles are now 55% less jibbly (#200)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build news section — build_news","text":"automatically link release announcements, include releases section.   Control whether news present one page multiple pages one_page field. default true.   Suppress default addition CRAN release dates :","code":"news:  releases:  - text: \"usethis 1.3.0\"    href: https://www.tidyverse.org/articles/2018/02/usethis-1-3-0/  - text: \"usethis 1.0.0 (and 1.1.0)\"    href: https://www.tidyverse.org/articles/2017/11/usethis-1.0.0/ news:   one_page: false news:   cran_dates: false"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":null,"dir":"Reference","previous_headings":"","what":"Build reference section — build_reference","title":"Build reference section — build_reference","text":"default, pkgdown generate index lists functions alphabetical order. override , provide reference section _pkgdown.yml described .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build reference section — build_reference","text":"","code":"build_reference(   pkg = \".\",   lazy = TRUE,   examples = TRUE,   run_dont_run = FALSE,   seed = 1014L,   override = list(),   preview = NA,   devel = TRUE,   document = \"DEPRECATED\",   topics = NULL )  build_reference_index(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build reference section — build_reference","text":"pkg Path package. lazy TRUE, rebuild pages .Rd recent .html. makes much easier rapidly prototype. set FALSE build_site(). examples Run examples? run_dont_run Run examples surrounded \\dontrun? seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. devel Determines code loaded order run examples. TRUE (default), assumes live development environment, loads source package pkgload::load_all(). FALSE, uses installed version package. document Deprecated Use devel instead. topics Build specified topics. supplied, sets lazy preview FALSE.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"reference-index","dir":"Reference","previous_headings":"","what":"Reference index","title":"Build reference section — build_reference","text":"tweak index page, add section called reference _pkgdown.yml. can contain three different types element: title (title + desc), generates row containing <h2> optional paragraph description. subtitle (subtitle + desc), generates row containing <h3> optional paragraph description. list topics (contents), generates one row topic, list aliases topic left, topic title right. (historical reasons can include contents title subtitle, longer recommended). packages need use title contents components. example, snippet YAML pkgdown uses generate reference index:   Bigger packages, e.g. ggplot2, may need additional layer structure order clearly organise large number functions:   desc can use markdown, long description good idea take advantage YAML > notation:","code":"reference: - title: Build   desc:  Build a complete site or its individual section components. - contents:   - starts_with(\"build_\") - title: Templates - contents:   - template_navbar   - render_page reference: - title: Layers - subtitle: Geoms   desc: Geom is short for geometric element - contents:   - starts_with(\"geom\") - subtitle: Stats   desc: Statistical transformations transform data before display.   contents:   - starts_with(\"stat\") desc: >   This is a very _long_ and **overly** flowery description of a   single simple function. By using `>`, it's easy to write a description   that runs over multiple lines."},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"topic-matching","dir":"Reference","previous_headings":"","what":"Topic matching","title":"Build reference section — build_reference","text":"contents can contain: Individual function/topic names. Weirdly named functions doubled quoting, YAML R, e.g. \"`+.gg`\". starts_with(\"prefix\") select functions common prefix. ends_with(\"suffix\") select functions common suffix. matches(\"regexp\") complex regular expressions. has_keyword(\"x\") select topics keyword \"x\"; has_keyword(\"datasets\") selects data documentation. has_concept(\"blah\") select topics concept \"blah\". using roxygen2, has_concept() also matches family tags, roxygen2 converts concept tags. lacks_concepts(c(\"concept1\", \"concept2\")) select topics without concepts. useful capture topics otherwise captured has_concepts(). Topics installed packages, e.g. rlang::is_installed() (function name) sass::font_face (topic name). functions (except has_keywords()) automatically exclude internal topics (.e. \\keyword{internal}). can choose include (e.g.) starts_with(\"build_\", internal = TRUE). Use leading - remove topics section, e.g. -topic_name, -starts_with(\"foo\"). pkgdown check non-internal topics included reference index page, error missed .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"missing-topics","dir":"Reference","previous_headings":"","what":"Missing topics","title":"Build reference section — build_reference","text":"pkgdown warn (non-internal) topics listed reference index. can suppress warnings listing topics section \"title: internal\" (case sensitive) displayed reference index.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"icons","dir":"Reference","previous_headings":"","what":"Icons","title":"Build reference section — build_reference","text":"can optionally supply icon help topic. , need top-level icons directory. contain .png files either 30x30 (regular display) 60x60 (want retina display). Icons matched topics aliases.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build reference section — build_reference","text":"need run extra code examples run, can create pkgdown/pre-reference.R pkgdown/post-reference.R.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"figures","dir":"Reference","previous_headings":"","what":"Figures","title":"Build reference section — build_reference","text":"can control default rendering figures specifying figures field _pkgdown.yml. default settings equivalent :   parameters interpreted similarly knitr chunk options. .parameters list parameters available custom graphics output devices HTML widgets.","code":"figures:   dev: ragg::agg_png   dpi: 96   dev.args: []   fig.ext: png   fig.width: 7.2916667   fig.height: ~   fig.retina: 2   fig.asp: 1.618   bg: NA   other.parameters: []"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":null,"dir":"Reference","previous_headings":"","what":"Build search index — build_search","title":"Build search index — build_search","text":"Build JSON file encompassing HTML pages, use search script.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build search index — build_search","text":"","code":"build_search(pkg = \".\", override = list())"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build search index — build_search","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build search index — build_search","text":"can exclude paths search index. exclude changelog search index.","code":"search:   exclude: ['news/index.html']"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"debugging-and-local-testing","dir":"Reference","previous_headings":"","what":"Debugging and local testing","title":"Build search index — build_search","text":"Locally (opposed GitHub Pages Netlify instance), search work simply use pkgdown preview static files. can use servr::httw(\"docs\") instead. search working, run pkgdown::pkgdown_sitrep() eliminate common issues absence URL pkgdown configuration file package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a complete pkgdown website — build_site","title":"Build a complete pkgdown website — build_site","text":"build_site() convenient wrapper around six functions: init_site() build_home() build_reference() build_articles() build_tutorials() build_news() See documentation function learn control aspect site. page documents options affect whole site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a complete pkgdown website — build_site","text":"","code":"build_site(   pkg = \".\",   examples = TRUE,   run_dont_run = FALSE,   seed = 1014L,   lazy = FALSE,   override = list(),   preview = NA,   devel = FALSE,   new_process = !devel,   install = !devel,   document = \"DEPRECATED\" )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a complete pkgdown website — build_site","text":"pkg Path package. examples Run examples? run_dont_run Run examples surrounded \\dontrun? seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. lazy TRUE, rebuild articles reference pages source newer destination. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. devel Use development deployment process? TRUE, uses lighter-weight process suitable rapid iteration; run examples vignettes current process, load code pkgload::load_all(). FALSE, first install package temporary library, run examples vignettes new process. build_site() defaults devel = FALSE get high fidelity outputs building complete site; build_reference(), build_home() friends default devel = TRUE can rapidly iterate development. new_process TRUE, run build_site() separate process. enhances reproducibility ensuring nothing loaded current process affects build process. install TRUE, install package temporary library available vignettes. document Deprecated Use devel instead.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"general-config","dir":"Reference","previous_headings":"","what":"General config","title":"Build a complete pkgdown website — build_site","text":"destination controls site generated, defaulting docs/. Paths relative package root. url optional, strongly recommended.   specifies site published used allow pkgdown sites link site needed (vignette(\"linking\")), generate sitemap.xml, automatically generate CNAME deploying github, generate metadata needed rich social \"media cards\" (vignette(\"metadata\")), . title overrides default site title, package name. used page title default navbar.","code":"url: https://pkgdown.r-lib.org"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"development-mode","dir":"Reference","previous_headings":"","what":"Development mode","title":"Build a complete pkgdown website — build_site","text":"development field allows generate different sites development released versions package. use , first need set development mode:","code":"development:   mode: auto"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"setting-development-mode","dir":"Reference","previous_headings":"","what":"Setting development mode","title":"Build a complete pkgdown website — build_site","text":"development mode site controls site built, colour package version navbar, version tooltip, whether site indexed search engines. four possible modes: automatic (mode: auto): automatically determines mode based version number: 0.0.0.9000 (0.0.0.*): unreleased. four version components: development. everything else -> release. release (mode: release), default. Site written docs/. Version navbar gets default colouring. Development badges shown sidebar (see ?build_home). development (mode: devel). Site written docs/dev/. navbar version gets \"danger\" class tooltip stating docs -development version package. noindex meta tag used ensure packages indexed search engines. Development badges shown sidebar (see ?build_home). unreleased (mode: unreleased). Site written docs/. Version navbar gets \"danger\" class, message indicating package yet CRAN. Development badges shown sidebar (see ?build_home). can override mode specified _pkgdown.yml setting setting PKGDOWN_DEV_MODE devel release.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"selective-html","dir":"Reference","previous_headings":"","what":"Selective HTML","title":"Build a complete pkgdown website — build_site","text":"can selectively show HTML devel release site adding class pkgdown-devel pkgdown-release. easily accessed .Rmd files can use pandoc's <div> syntax control block markdown display. example, can use following markdown README show GitHub install instructions development version site:   can use similar technique control badges displayed. markdown show CRAN status badge site released package GitHub check status development package:","code":"::: {.pkgdown-devel} You can install the development version of pkgdown from GitHub with: `remotes::install_github(\"r-lib/pkgdown\")` ::: [![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)]   (https://cran.r-project.org/package=pkgdown){.pkgdown-release} [![R-CMD-check](https://github.com/r-lib/pkgdown/workflows/R-CMD-check/badge.svg)]   (https://github.com/r-lib/pkgdown/actions){.pkgdown-devel}"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"other-options","dir":"Reference","previous_headings":"","what":"Other options","title":"Build a complete pkgdown website — build_site","text":"three options can control:   destination allows override default subdirectory used development site; defaults dev/. version_label allows override style used development (unreleased) versions package. defaults \"danger\", can set \"default\", \"info\", \"warning\" instead. (precise colours determined bootstrap theme, become progressively eye catching go default danger). Finally, can choose override default tooltip version_tooltip.","code":"development:   destination: dev   version_label: danger   version_tooltip: \"Custom message here\""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"page-layout","dir":"Reference","previous_headings":"","what":"Page layout","title":"Build a complete pkgdown website — build_site","text":"navbar, footer, sidebar fields control appearance navbar, footer, sidebar respectively. many individual options documented Layout section vignette(\"customise\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"search","dir":"Reference","previous_headings":"","what":"Search","title":"Build a complete pkgdown website — build_site","text":"search field controls built-search documented vignette(\"search\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"template","dir":"Reference","previous_headings":"","what":"Template","title":"Build a complete pkgdown website — build_site","text":"template field mostly used control appearance site. See vignette(\"customise\") details. two template fields control aspects site: noindex: true suppress indexing pages search engines:   google_site_verification allows verify site google:   trailing_slash_redirect: true automatically redirect -package-url.com -package-url.com/, using JS script added <head> home page. useful certain redirect scenarios.","code":"template:   params:     noindex: true template:   params:     google_site_verification: _nn6ile-a6x6lctOW template:   trailing_slash_redirect: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"analytics","dir":"Reference","previous_headings":"","what":"Analytics","title":"Build a complete pkgdown website — build_site","text":"capture usage site web analytics platform, can make use includes field add HTML supplied platform. Typically either placed after_body in_header. include examples , highly recommend getting recommended HTML directly platform. GoatCounter:   Google analytics:   plausible.io:","code":"template:   includes:     after_body: >       <script data-goatcounter=\"https://{YOUR CODE}.goatcounter.com/count\" data-goatcounter-settings=\"{YOUR SETTINGS}\" async src=\"https://gc.zgo.at/count.js\"><\/script> template:   includes:     in_header: |        <!-- Global site tag (gtag.js) - Google Analytics -->        <script async src=\"https://www.googletagmanager.com/gtag/js?id={YOUR TRACKING ID}\"#' ><\/script>        <script>          window.dataLayer = window.dataLayer || [];          function gtag(){dataLayer.push(arguments);}          gtag('js', new Date());           gtag('config', '{YOUR TRACKING ID}');        <\/script> templates:   includes:     in_header: |       <script defer data-domain=\"{YOUR DOMAIN}\" src=\"https://plausible.io/js/plausible.js\"><\/script>"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"source-repository","dir":"Reference","previous_headings":"","what":"Source repository","title":"Build a complete pkgdown website — build_site","text":"Use repo field override pkgdown's automatically discovery source repository. used navbar, homepage, articles reference topics, changelog (link issue numbers user names). pkgdown can automatically figure necessary URLs link GitHub GitLab repo BugReports URL field. Otherwise, can supply repo field:   home: path package home source code repository. source:: path source individual file default branch. issue: path individual issue. user: path user. varying components (e.g. path, issue number, user name) pasted end URLs trailing /s. pkgdown can automatically link Jira issues well specify custom issue URL well Jira project names auto-link jira_projects. can specify many projects like:   pkgdown defaults using \"HEAD\" branch source file URLs. can configured use specific branch linking source files specifying branch name:","code":"repo:   url:     home: https://github.com/r-lib/pkgdown/     source: https://github.com/r-lib/pkgdown/blob/HEAD/     issue: https://github.com/r-lib/pkgdown/issues/     user: https://github.com/ repo:   jira_projects: [this_project, another_project]   url:     issue: https://jira.organisation.com/jira/browse/ repo:   branch: devel"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"deployment-deploy-","dir":"Reference","previous_headings":"","what":"Deployment (deploy)","title":"Build a complete pkgdown website — build_site","text":"single deploy field install_metadata allows install package index metadata package . Normally metadata made available published site; installing package means available autolinking even website reachable build time (e.g. behind firewall requires auth).","code":"deploy:   install_metadata: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"redirects","dir":"Reference","previous_headings":"","what":"Redirects","title":"Build a complete pkgdown website — build_site","text":"change structure documentation (renaming vignettes help topics) can setup redirects old content new content. One several now-absent pages can redirected new page (new section new page). works creating html page performs \"meta refresh\", best way redirect works everywhere might deploy site. syntax following, old paths left, new paths URLs right.   reason choose redirect existing page make sure exclude search index, see ?build_search.","code":"redirects:   - [\"articles/old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/another-old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/yet-another-old-vignette-name.html\", \"https://pkgdown.r-lib.org/dev\"]"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"options","dir":"Reference","previous_headings":"","what":"Options","title":"Build a complete pkgdown website — build_site","text":"Users limited internet connectivity can disable CRAN checks setting options(pkgdown.internet = FALSE). also disable features pkgdown requires internet connectivity. However, used build docs package requires internet connectivity examples vignettes, connection required option apply . Users can set timeout build_site(new_process = TRUE) options(pkgdown.timeout = Inf), useful prevent stalled builds hanging cron jobs.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a complete pkgdown website — build_site","text":"","code":"if (FALSE) { build_site()  build_site(override = list(destination = tempdir())) }"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":null,"dir":"Reference","previous_headings":"","what":"Build site for GitHub pages — build_site_github_pages","title":"Build site for GitHub pages — build_site_github_pages","text":"Designed run part automated workflows deploying GitHub pages. cleans old site, builds site dest_dir adds .nojekyll file suppress rendering Jekyll, adds CNAME file needed. designed run CI, default : Cleans old site. install package. Runs build_site() process.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build site for GitHub pages — build_site_github_pages","text":"","code":"build_site_github_pages(   pkg = \".\",   ...,   dest_dir = \"docs\",   clean = TRUE,   install = FALSE,   new_process = FALSE )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build site for GitHub pages — build_site_github_pages","text":"pkg Path package. ... Additional arguments passed build_site(). dest_dir Directory build site . clean Clean files old site. install TRUE, install package temporary library available vignettes. new_process TRUE, run build_site() separate process. enhances reproducibility ensuring nothing loaded current process affects build process.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":null,"dir":"Reference","previous_headings":"","what":"Build tutorials section — build_tutorials","title":"Build tutorials section — build_tutorials","text":"learnr tutorials must hosted elsewhere require R execution engine. Currently, pkgdown build publish tutorials , makes easy embed (using <iframe>s) published tutorials. Tutorials automatically discovered published tutorials inst/tutorials vignettes/tutorials. Alternatively, can list _pkgdown.yml described .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build tutorials section — build_tutorials","text":"","code":"build_tutorials(pkg = \".\", override = list(), preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build tutorials section — build_tutorials","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build tutorials section — build_tutorials","text":"override default discovery process, can provide tutorials section. list element specifies: name: used generated file name title: used page heading navbar url: embedded iframe source: optional, present linked ","code":"tutorials: - name: 00-setup   title: Setting up R   url: https://jjallaire.shinyapps.io/learnr-tutorial-00-setup/ - name: 01-data-basics   title: Data basics   url: https://jjallaire.shinyapps.io/learnr-tutorial-01-data-basics/"},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Check _pkgdown.yml — check_pkgdown","title":"Check _pkgdown.yml — check_pkgdown","text":"Check _pkgdown.yml valid without building whole site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check _pkgdown.yml — check_pkgdown","text":"","code":"check_pkgdown(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check _pkgdown.yml — check_pkgdown","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Clean site — clean_site","title":"Clean site — clean_site","text":"Delete files docs/ (except CNAME).","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clean site — clean_site","text":"","code":"clean_site(pkg = \".\", quiet = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clean site — clean_site","text":"pkg Path package. quiet TRUE, suppresses message.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"deploy_site_github() designed deploy site Travis CI, longer recommend, function deprecated. two replacements: usethis::use_pkgdown_github_pages() setup GitHub action automatically build deploy package website GitHub pages. deploy_to_branch() can called locally build deploy website desired branch.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"","code":"deploy_site_github(   pkg = \".\",   install = TRUE,   tarball = Sys.getenv(\"PKG_TARBALL\", \"\"),   ssh_id = Sys.getenv(\"id_rsa\", \"\"),   commit_message = construct_commit_message(pkg),   clean = FALSE,   verbose = FALSE,   host = \"github.com\",   ...,   repo_slug = Sys.getenv(\"TRAVIS_REPO_SLUG\", \"\") )"},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"pkg Path package. install Optionally, opt-automatic installation. necessary package documenting dependency pkgdown tarball location built package tarball. default Travis configuration R packages sets PKG_TARBALL path. ssh_id private id use, base64 encoded content private pem file. personal private key. Instead create new keypair specifically deploying site. easiest way use travis::use_travis_deploy(). commit_message commit message used commit. clean Clean files old site. verbose Print verbose output host GitHub host url. ... Additional arguments passed build_site(). repo_slug user/repo slug repository.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":null,"dir":"Reference","previous_headings":"","what":"Build and deploy a site locally — deploy_to_branch","title":"Build and deploy a site locally — deploy_to_branch","text":"Assumes git clone project, package already installed. Use usethis::use_pkgdown_github_pages() automate process using GitHub actions.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build and deploy a site locally — deploy_to_branch","text":"","code":"deploy_to_branch(   pkg = \".\",   commit_message = construct_commit_message(pkg),   clean = TRUE,   branch = \"gh-pages\",   remote = \"origin\",   github_pages = (branch == \"gh-pages\"),   ...,   subdir = NULL )"},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build and deploy a site locally — deploy_to_branch","text":"pkg Path package. commit_message commit message used commit. clean Clean files old site. branch git branch deploy remote git remote deploy github_pages GitHub pages deploy. TRUE, adds CNAME file custom domain name support, .nojekyll file suppress jekyll rendering. ... Additional arguments passed build_site(). subdir sub-directory site built branch. argument can used support number site configurations. example, build version-specific documentation setting subdir = \"v1.2.3\"; deploy_to_branch() build deploy package documentation v.1.2.3/ directory site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":null,"dir":"Reference","previous_headings":"","what":"Get current settings for figures — fig_settings","title":"Get current settings for figures — fig_settings","text":"generally need use function unless handling custom plot output. Packages needing custom parameters ask users place within .parameters entry package name, e.g.","code":"figures:   other.parameters:     rgl:       fig.asp: 1"},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get current settings for figures — fig_settings","text":"","code":"fig_settings()"},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get current settings for figures — fig_settings","text":"list containing entries figures field _pkgdown.yml (see build_reference()), default values added. Computed width height values (pixels) also included.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Determine if code is executed by pkgdown — in_pkgdown","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"occasionally useful need different behaviour pkgdown regular documentation.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"","code":"in_pkgdown()"},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"","code":"in_pkgdown() #> [1] TRUE"},{"path":"https://pkgdown.r-lib.org/dev/reference/index-topic.html","id":null,"dir":"Reference","previous_headings":"","what":"Index — index","title":"Index — index","text":"Index","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialise site infrastructure — init_site","title":"Initialise site infrastructure — init_site","text":"init_site(): creates output directory (docs/), generates machine readable description site, used autolinking, copies CSS/JS assets extra files, runs build_favicons(), needed. See vignette(\"customise\") various ways can customise display site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialise site infrastructure — init_site","text":"","code":"init_site(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialise site infrastructure — init_site","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"build-ignored-files","dir":"Reference","previous_headings":"","what":"Build-ignored files","title":"Initialise site infrastructure — init_site","text":"recommend using usethis::use_pkgdown() build-ignore docs/ _pkgdown.yml. use another directory, create site manually, need add .Rbuildignore . NOTE unexpected file R CMD CHECK indication correctly ignored files.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown-package.html","id":null,"dir":"Reference","previous_headings":"","what":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","title":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","text":"Generate attractive useful website source package. 'pkgdown' converts documentation, vignettes, 'README', 'HTML' making easy share information package online.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","text":"Maintainer: Hadley Wickham hadley@posit.co (ORCID) Authors: Jay Hesselberth (ORCID) Maëlle Salmon (ORCID) contributors: Posit Software, PBC [copyright holder, funder]","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":null,"dir":"Reference","previous_headings":"","what":"Print object in pkgdown output — pkgdown_print","title":"Print object in pkgdown output — pkgdown_print","text":"lets package authors control objects printed just pkgdown examples. default call print() apart htmlwidgets object returned (sizes tweaked).","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print object in pkgdown output — pkgdown_print","text":"","code":"pkgdown_print(x, visible = TRUE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print object in pkgdown output — pkgdown_print","text":"x Object display visible Whether visible ","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print object in pkgdown output — pkgdown_print","text":"Either character vector representing printed output (escaped HTML necessary) literal HTML produced htmltools htmlwidgets packages.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":null,"dir":"Reference","previous_headings":"","what":"Report package pkgdown situation — pkgdown_sitrep","title":"Report package pkgdown situation — pkgdown_sitrep","text":"pkgdown_sitrep() reports url field pkgdown configuration; pkgdown website URL stored DESCRIPTION file.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Report package pkgdown situation — pkgdown_sitrep","text":"","code":"pkgdown_sitrep(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Report package pkgdown situation — pkgdown_sitrep","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Preview a local pkgdown page in the browser — preview_page","title":"Preview a local pkgdown page in the browser — preview_page","text":"works rendering working directory, common interactive workflow.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Preview a local pkgdown page in the browser — preview_page","text":"","code":"preview_page(path, pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Open site in browser — preview_site","title":"Open site in browser — preview_site","text":"Open site browser","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Open site in browser — preview_site","text":"","code":"preview_site(pkg = \".\", path = \".\", preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Open site in browser — preview_site","text":"pkg Path package. path Path relative destination preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":null,"dir":"Reference","previous_headings":"","what":"Translate an Rd string to its HTML output — rd2html","title":"Translate an Rd string to its HTML output — rd2html","text":"Translate Rd string HTML output","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Translate an Rd string to its HTML output — rd2html","text":"","code":"rd2html(x, fragment = TRUE, ...)"},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Translate an Rd string to its HTML output — rd2html","text":"x Rd string. Backslashes must double-escaped (\"\\\\\"). fragment logical indicating whether represents complete Rd file ... additional arguments as_html","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Translate an Rd string to its HTML output — rd2html","text":"","code":"rd2html(\"a\\n%b\\nc\") #> [1] \"a\"           \"<!-- %b -->\" \"c\"            rd2html(\"a & b\") #> [1] \"a &amp; b\"  rd2html(\"\\\\strong{\\\\emph{x}}\") #> [1] \"<strong><em>x<\/em><\/strong>\""},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Render page with template — render_page","title":"Render page with template — render_page","text":"page composed four templates: \"head\", \"header\", \"content\", \"footer\". templates rendered using data, assembled overall page using \"layout\" template.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render page with template — render_page","text":"","code":"render_page(pkg = \".\", name, data, path, depth = NULL, quiet = FALSE)  data_template(pkg = \".\", depth = 0L)"},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render page with template — render_page","text":"pkg Path package document. name Name template (e.g. \"home\", \"vignette\", \"news\") data Data template. automatically supplemented three lists: site: title path root. yaml: template key _pkgdown.yml. package: package metadata including name andversion. See full contents running data_template(). path Location create file; relative destination directory. depth Depth path relative base directory. quiet quiet, suppress output messages","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate YAML templates — template_navbar","title":"Generate YAML templates — template_navbar","text":"Use function generate default YAML pkgdown uses different parts _pkgdown.yml. useful starting points want customise site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate YAML templates — template_navbar","text":"","code":"template_navbar(path = \".\")  template_reference(path = \".\")  template_articles(path = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate YAML templates — template_navbar","text":"path Path package root","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate YAML templates — template_navbar","text":"","code":"if (FALSE) { pkgdown::template_navbar() }  if (FALSE) { pkgdown::template_reference() }  if (FALSE) { pkgdown::template_articles() }"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-crayon.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: crayon — test-crayon","title":"Test case: crayon — test-crayon","text":"Test case: crayon","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-crayon.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: crayon — test-crayon","text":"","code":"cat(cli::col_red(\"This is red\"), \"\\n\") #> This is red  cat(cli::col_blue(\"This is blue\"), \"\\n\") #> This is blue   message(cli::col_green(\"This is green\")) #> This is green  warning(cli::style_bold(\"This is bold\")) #> Warning: This is bold"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-dont.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: don't — test-dont","title":"Test case: don't — test-dont","text":"Test case: ","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-dont.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: don't — test-dont","text":"","code":"if (FALSE) {   abort(\"This is an error!\") }  # Inline \\donttest is silently ommitted message(\"Hi!\") #> Hi!  # Block \\donttest indicated with comments # \\donttest{ # This is a comment 1 + 3 #> [1] 4 # }  # And works even when not at the top level if (TRUE) {   # \\donttest{   1 + 2   # } } #> [1] 3  answer <- 1 # \\dontshow{ answer <- 42 # } answer # should be 42 #> [1] 42  # To hide the \\dontshow part, for conditional examples if (FALSE) { answer <- 43 } answer # should be still 42 #> [1] 42  # But this one runs, and the condition is hidden answer <- 43 answer #> [1] 43"},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-figures.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: figures — test-figures","text":"","code":"x <- seq(0, 2 * pi, length.out = 25) plot(x, sin(x))   plot(1:10) lines(1:10) text(2, 5, \"Hello\", srt = 30, cex = 2)"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-links.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: links — test-links","title":"Test case: links — test-links","text":"","code":"magrittr::subtract(10, 1) #> [1] 9"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-links.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: links — test-links","text":"","code":"magrittr::subtract(10, 1) #> [1] 9  library(magrittr, warn.conflicts = FALSE) subtract(10, 1) #> [1] 9"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"bulleted-list","dir":"Reference","previous_headings":"","what":"Bulleted list","title":"Test case: lists — test-lists","text":"item... spans multiple paragraphs.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"numbered-list","dir":"Reference","previous_headings":"","what":"Numbered list","title":"Test case: lists — test-lists","text":"b","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"definition-list","dir":"Reference","previous_headings":"","what":"Definition list","title":"Test case: lists — test-lists","text":"short short short Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad   minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip   ex ea commodo consequat. Duis aute irure dolor reprehenderit   voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur   sint occaecat cupidatat non proident, sunt culpa qui officia deserunt   mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. short Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum   adipiscing elit, sed  eiusmod tempor incididunt ut labore et dolore ad   minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip   ex ea commodo consequat. Duis aute irure dolor reprehenderit   voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur   sint occaecat cupidatat non proident, sunt culpa qui officia deserunt   mollit anim id est laborum.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-long-lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: long-lines — test-long-lines","title":"Test case: long-lines — test-long-lines","text":"example results copy button correctly placed scrollings","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-long-lines.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: long-lines — test-long-lines","text":"","code":"pkgdown:::ruler() #> ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 #> 12345678901234567890123456789012345678901234567890123456789012345678901234567890  cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x  cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x  cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-output-styles.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: output styles — test-output-styles","title":"Test case: output styles — test-output-styles","text":"Test case: output styles","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-output-styles.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: output styles — test-output-styles","text":"","code":"# This example illustrates some important output types # The following output should be wrapped over multiple lines a <- 1:100 a #>   [1]   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18 #>  [19]  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36 #>  [37]  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54 #>  [55]  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72 #>  [73]  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90 #>  [91]  91  92  93  94  95  96  97  98  99 100  cat(\"This some text!\\n\") #> This some text! message(\"This is a message!\") #> This is a message! warning(\"This is a warning!\") #> Warning: This is a warning!  # This is a multi-line block {   1 + 2   2 + 2 } #> [1] 4"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-params.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: params — test-params","title":"Test case: params — test-params","text":"Test case: params","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Test case: params — test-params","text":"... ellipsis","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-sexpr-title.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: sexpr — test-sexpr-title","title":"Test case: sexpr — test-sexpr-title","text":"Test case: sexpr","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: preformatted blocks & syntax highlighting — test-verbatim","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Manual test cases various ways embedding code sections. code blocks copy paste button.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":"should-be-highlighted","dir":"Reference","previous_headings":"","what":"Should be highlighted","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Valid R code \\preformatted{}:   R code R block:   R code r block:   Yaml","code":"mean(a + 1) mean(a + 1) mean(a + 1) yaml: [a, 1]"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":"shouldn-t-be-highlighted","dir":"Reference","previous_headings":"","what":"Shouldn't be highlighted","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Non-R code \\preformatted{}","code":"yaml: [a, b, c]"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-development-version","dir":"Changelog","previous_headings":"","what":"pkgdown (development version)","title":"pkgdown (development version)","text":"left right footers longer contain extra empty paragraph tag footer gains additional padding-top keep whitespace constant (#2381). build_article_index() build_reference_index() use improved BS5 template correctly wraps section description <div>, rather <p>. eliminates empty pargraph tag preceded section description (#2352). build_news() now warns doesn’t find version headings, suggesting NEWS.md structured incorrectly (#2213). build_article() gains new new_process argument allows build vignette current process debugging purposes. ’ve also improved error messages tracebacks article fails build, hopefully also making debugging easier (#2438). Preview links now work (#2435). build_home() longer renders Github issue pull request templates (@hsloot, #2362) now easier preview parts website locally interactively. build_reference_index() friends call init_site() internally instead erroring (@olivroy, #2329). Fixed issue introduced 2.0.8 pkgdown using Bootstrap version specified template package (@gadenbuie, #2443). check_pkgdown() longer errors intro vignette article listed _pkgdown.yml (@olivroy #2150).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-208","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.8","title":"pkgdown 2.0.8","text":"CRAN release: 2024-04-10 pkgdown now compatible (requires) bslib >= 0.5.1 (@gadenbuie, #2395), including fix BS5 navbar template get navbar.type: dark work Bootstrap 5.3+ (@tanho63, #2388) Now uses cli provide interactive feedback. Avoid unwanted linebreaks parsing DESCRIPTION (@salim-b, #2247). Translations New Catalan translation (@jmaspons, #2333). Citation sections correctly translated (@eliocamp, #2410). build_article_index() now sorts vignettes non-vignette articles alphabetically filename (literally, basename()), default (@jennybc, #2253). Deprecated build_favicon() removed (build_favicons() remains). build_articles() now sets RNG seed default. Use build_articles(seed = NULL) old (unreproducible) behaviour. (@salim-b, #2354). build_articles() process .qmd articles quarto vignette builder (@rcannood, #2404). build_articles() build_reference() now set RNG seed htmlwidgets IDs. reduces noise final HTML output, articles examples contain htmlwidgets (@salim-b, #2294, #2354). build_news() correctly parses github profiles issues links present beginning list items (@pearsonca, #2122) build_reference() sets seed correctly; previously reset early (@salim-b, #2355) Rd -> html translation \\cr now translated <br> <br /> (#2400). Correct usage S3 methods non-syntactic class names (#2384). Preserve Markdown code blocks class rmd roxygen2 docs (@salim-b, #2298). build_reference_index() longer generates redundant entries multiple explicit @usage tags provided (@klmr, #2302) build_reference_index() correctly handles topic names conflict selector functions (@dmurdoch, #2397).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-207","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.7","title":"pkgdown 2.0.7","text":"CRAN release: 2022-12-14 Fix topic match selection unmatched selection followed matched selection (@bundfussr, #2234) Fix highlighting nested R code blocks (instance, example R Markdown code chunks) (@idavydov, #2237). Tweak German translation (@krlmlr, @mgirlich, @lhdjung, #2149, #2236) Remove mention (defunct) Twitter card validator, provide alternatives (@Bisaloo, #2185) Fix keywords typo check_missing_topics() message (@swsoyee, #2178). Use jsdeliver CDN bootstrap-toc (@GregorDeCillia, #2207).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-206","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.6","title":"pkgdown 2.0.6","text":"CRAN release: 2022-07-16 ’re using RStudio daily, output file names now clickable, previewing generated HTML browser (#2157). Getting started vignette longer needs included articles index (#2150). aren’t functions \\usage{} block, pkgdown now shows aliases reference index, rather just topic name (#1624).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-205","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.5","title":"pkgdown 2.0.5","text":"CRAN release: 2022-06-23 Correctly generate downlit link targets topics file name ending . (#2128). build_articles(): build fails index doesn’t include articles, ’re now told articles missing (@zkamvar, #2121). build_home() now escapes angle brackets author comments(#2127). build_home() automatically render link .github/SUPPORT.md (@IndrajeetPatil, #2124). build_news() fails link @username start bullet. reverted #2030 #2122. build_reference(): restore accidentally nerfed has_keyword() has_concept() reference selectors (#2126) add tests.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-204","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.4","title":"pkgdown 2.0.4","text":"CRAN release: 2022-06-10 New check_pkgdown() provides lightweight way check _pkgdown.yml valid without building site (#2056). Invalid _pkgdown.yml now consistently generates errors locally CI (#2055). build_article() now supports inline markdown title (#2039). build_home() longer shows development status badges released version site (#2054). build_news() support automated @username links places (#2030). build_reference(): can exclude topics reference index - (#2040). Inline markdown titles subtitles now supported(#2039). Package logos automatically stripped .Rd don’t end two one page. (#2083). \\figure{file}{alternative text} multiline alt text now parsed correctly (#2080) roxygen 7.2.0 output generic code blocks (#2092, @jabenninghoff) processed correctly. Front end changes: Automatically added links code blocks now styled less aggressively, occupy less visual weight page (#2007). article pages given class col-md-9 consistency pages (#2045). Fixed width HTML widgets sized correctly (@dmurdoch, #2062). Footnotes work contents, including code (@banfai, #2042). Navbar components now accept target argument (#2089, @JSchoenbachler). New syntax highlighting themes a11y-light, a11y-dark, monochrome-light, monochrome-dark, solarized","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-203","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.3","title":"pkgdown 2.0.3","text":"CRAN release: 2022-04-24 Fixes R CMD check","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-202","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.2","title":"pkgdown 2.0.2","text":"CRAN release: 2022-01-13 New Korean (ko) translation thanks @mrchypark @peremen (#1944). New Danish (dk) translation thanks @LDalby. build_articles() now adjusts heading levels vignettes/articles use <h1> section headings ensure ’s one top-level heading (#2004). ensures ’s one <h1>, title, page, makes TOC sidebar work correctly. build_home_index() longer spuriously complains missing images use plots README.Rmd (#1980, #1977). longer tweaks src path <img> tags absolute paths (#1955). build_news() works NEWS.md uses <h1> headings (#1947). build_reference() now correctly interprets title: internal: removes section reference index doesn’t list topics section missing (#1958). build_reference() now gives correct hint reference index YAML formatted correctly (e.g. empty item, item “n” needs escaped quotes interpreted Boolean) (#1995). deploy_to_branch() gains subdir argument, allowing deploy site subdirectory (@gadenbuie, #2001). Front end changes: navbar gets little space version number, aligns baseline rest navbar (#1989). Long lines code output scroll, rather wrapped. different ’ll see console, ’s better fit web pages available code width varies based browser width (#1940). scrollspy (highlights “active” heading sidebar) now computes offset dynamically makes work better sites taller navbars (#1993). Fixed js issues occurred pages without table contents (@gadenbuie, #1998). htmlwidgets jQuery Bootstrap dependencies used examples articles, pkgdown’s versions jQuery Boostrap take precedence versions used htmlwidget (@gadenbuie, #1997). pkgdown longer includes bundled author metadata Hadley Wickham, RStudio, RConsortium, since now ways include meta data template packages, special casing three entities feels increasingly weird (#1952).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-201","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.1","title":"pkgdown 2.0.1","text":"CRAN release: 2021-12-03 Fix CRAN failures. Reference sections de-duplicated correctly (#1935). Usage sections generated topics ; usage correctly displayed BS3 (#1931) Empty \\value{} longer errors (#1930).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-200","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.0","title":"pkgdown 2.0.0","text":"CRAN release: 2021-11-30","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-authors-2-0-0","dir":"Changelog","previous_headings":"","what":"New authors","title":"pkgdown 2.0.0","text":"@maelle now pkgdown author recognition significant sustained contributions. powerhouse behind many improvements release, particularly switch bootstrap 5, improvements customisation, implementation local search.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"bootstrap-2-0-0","dir":"Changelog","previous_headings":"","what":"Bootstrap 5","title":"pkgdown 2.0.0","text":"pkgdown can style site Bootstrap 5 (help @jayhesselberth, @apreshill, @cpsievert). Opt-setting boostrap version _pkgdown.yml: reviewed site accessibility made number small improvements: (#782, #1553): Default font larger links always underlined. Heading anchors use aria-hidden reduce noise screenreader users. Navbar dropdowns improved aria-labelledby. default GitHub/GitLab links gain aria-label; use icons now supported, encouraged docs. Syntax highlighting uses new accessible colour scheme, designed Alison Hill (#1536) skip link makes easier get directly page contents (#1827). -line footnotes mean can read asides next text refer . Articles support tabsets, R Markdown. (@JamesHWade, #1667). minor styling improvements: active item TOC indicated background colour, rather border. present, package logo shown pages near header. Section anchors now appear right (making usable mobile phones) (#1782). TOC scrollable independently main content. makes useful long pages many headings (#1610). sidebar shown bottom page narrow screens. Function arguments reference index (#1822) use definition lists (<dl>) instead tables. gives room long argument names/lists function detailed descriptions, displays better mobile. Links homepage longer show full url text. default navbar longer includes home icon - took precious horizontal space wasn’t useful since already link home page immediately left (#1383).","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"local-search-2-0-0","dir":"Changelog","previous_headings":"","what":"Local search","title":"pkgdown 2.0.0","text":"pkgdown now supports local searching (.e. searching without external service), enabled default Bootstrap 5 sites since set-needed (#1629, help @gustavdelius #1655 @dieghernan & @GregorDeCillia #1770). pkgdown builds exhaustive sitemap.xml even websites built Bootstrap 3. might change Algolia results use Algolia search (#1629).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"customisation-2-0-0","dir":"Changelog","previous_headings":"","what":"Customisation","title":"pkgdown 2.0.0","text":"New vignette(\"customise\") documents ways can customise site, including new options described (#1573). Sites can easily themed either bootswatch themes selectively overriding bslib variables used generate CSS. pkgdown now uses scss Bootstrap css tweaks, means can customise site within _pkgdown.yml. can pick variety built-syntax highlighting themes (#1823). control colours (background) code <pre> tags. pkgdown can now translate text generates (#1446): means package docs written another language, can match pkgdown UI provide seamless experience non-English speakers. Activate translations setting lang _pkgdown.yml: pkgdown includes translations : es, Spanish, thanks @edgararuiz-zz, @dieghernan, @rivaquiroga. de, German, thanks @hfrick. fr, French, thanks @romainfrancois, @lionel-, @jplecavalier, @maelle. pt, Portuguese, thanks @rich-iannone. tr, Turkish, thanks @mine-cetinkaya-rundel. zh_CN, simplified Chinese, thanks @yitao. ’re interested adding translations language please file issue ’ll help get started. Template packages can now provide inst/pkgdown/_pkgdown.yml used set defaults _pkgdown.yml. can used (e.g.) provide author definitions, select Bootstrap version define bslib variables, customise sidebar, footer, navbar, etc. (#1499). New includes parameters -header, -body, -body make easy add arbitrary HTML every page. content placed end <head> tag, right opening <body> tag, closing tag <\/body> respectively (#1487). match bookdown options in_header, before_body after_body. Additionally, can use before_title, before_navbar, after_navbar add arbitrary HTML navbar/page header; appear left package name/version, left right navigation links respectively (#1882). Authors configuration flexible (#1516). can now: Choose roles used filtering authors sidebar footer. Choose text authors footer. Add text authors list sidebar. Add text authors list authors page. Sidebar specification flexible (#1443, #1488, #1502). can now: Change order sidebar elements. Add custom sidebar sections (Markdown/HTML text). Add table contents home page. Completely suppress sidebar. Provide HTML navbar. Footer specification flexible (#1502). can now: Change placement elements left right. Add text left right (even remove/replace default text) can now exclude default components navbar (#1517). Expert users can now override layout templates provided pkgdown template packages placing template files pkgdown/templates (@gadenbuie, #1897).","code":"lang: fr"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-2-0-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 2.0.0","text":"pkgdown now supports redirects (#1259, @lorenzwalthert). following yaml demonstrates syntax, old paths left new paths/URLs right. Use HTML classes pkgdown-devel pkgdown-release declare certain content appear devel release site. Use class pkgdown-hide content appear GitHub/CRAN (#1299). New pkgdown_sitrep() function reports whether site set correctly; particularly currently reports auto-linking work (#1478).","code":"redirects:   - [\"articles/old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/another-old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/yet-another-old-vignette-name.html\", \"https://pkgdown.r-lib.org/dev\"]"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"code-2-0-0","dir":"Changelog","previous_headings":"","what":"Code","title":"pkgdown 2.0.0","text":"Styling errors, warnings, messages tweaked. Messages now displayed way output, warnings errors bolded, coloured. part suite changes aim give package authors greater control appearance messages, warnings, errors. Long lines code output now wrapped, rather requiring scrolling. better matches rmarkdown::html_document() see console. build_reference() now allows linking topics packages (either function names e.g. rlang::is_installed topic names e.g.  sass::font_face). (#1664) build_reference() now runs examples options(rlang_interactive = FALSE) (ensuring non-interactive behaviour functions use rlang::is_interactive()), options(cli.dynamic = FALSE), Sys.setenv(RSTUDIO = NA) Sys.setLocale(\"LC_COLLATE\", \"C\") (#1693). also runs pkgdown/pre-reference.R pkgdown/post-reference.R examples. allow setup teardown operations might need (#1602). reference index section title: internal now silently dropped, allowing suppress warnings topics listed index (#1716). Code blocks now highlighted according declared language (e.g. yaml) documentation built roxygen2 7.1.2 later (#1690, #1692). New pkgdown_print() allows control objects rendered examples. includes built-handling htmlwidgets “browseable” HTML pkgdown output now closely resembles see RStudio. Added extension points make HTML widgets (RGL particular) work rendered examples (@dmurdoch). can globally set width code output (reference articles) Articles now render output styles created cli/crayon (#1556). copy pasting code blocks, lines containing output (e.g. #>) automatically omitted (#1675). Auto-linking improvements: Links inherited R6 methods now work correctly internal (#1173, @vandenman) external (#1476) parent classes. Linking longer fails package contains duplicated Rd aliases. Correctly link reference pages \\name{} entry doesn’t match file name (@dmurdoch, #1586; #1676).","code":"code:   width: 50"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-2-0-0","dir":"Changelog","previous_headings":"","what":"Articles","title":"pkgdown 2.0.0","text":"Article subtitle, author date (specified YAML frontmatter) now correctly omitted article table contents sidebar (@maxheld83, #1428). Support as_is: true non-default output formats vignettes/ articles somewhat improved. Support fundamentally limited due challenges integrating HTML output formats pkgdown doesn’t know , little reliable little better documented (#1757, #1764). build_articles() longer fails directory underneath vignettes .Rmd extension (#1425). build_articles() now correctly handles links images man/figures (form ../man/figures) (#1472). build_articles() sets theme argument document format NULL as_is: true lets users override via theme argument output format. build_articles() build_home() now warn images won’t render website ’re unsupported directories (#1810). Generally, ’s safe refer figures man/figures vignettes. Articles stored vignettes/articles moved one level appear articles/ website. Previously, appear articles/articles, build_redirects() automatically adds redirects articles vignettes/articles directory (@gadenbuie #1911).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"html-css-and-js-2-0-0","dir":"Changelog","previous_headings":"","what":"HTML, CSS and JS","title":"pkgdown 2.0.0","text":"New template option trailing_slash_redirect allows adding script redirect -package-url.com -package-url.com/ (#1439, @cderv, @apreshill). External links now get class external-link. makes easier style CSS (#881, #1491). Duplicated section ids now de-duplicated; makes pkgdown work better documentation R6 classes. Updated CSS styles pandoc improve styling reference lists (#1469).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"deployment-2-0-0","dir":"Changelog","previous_headings":"","what":"Deployment","title":"pkgdown 2.0.0","text":"build_site_github_pages() extracted deploy_site_github() make easier decouple building deployment, can take advantage standard deployment actions (#1756). deploy_to_branch() now calls git remote set-branches --add avoid overwriting existing remote.{remote}.fetch value (@kyleam, #1382). also now cleans website directory default; revert previous behaviour clean = FALSE (#1394). build_reference() error envar CI true missing topics (@ThierryO, #1378). can override auto development mode detected package version setting env var PKGDOWN_DEV_MODE release devel. useful package uses different convention indicate development release versions (#1081).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-minor-improvements-and-bug-fixes-2-0-0","dir":"Changelog","previous_headings":"","what":"Other minor improvements and bug fixes","title":"pkgdown 2.0.0","text":"\\special{} tags complex contents rendered correctly (@klmr, #1744). \\arguments{} \\value{} better job handling mingled items text (#1479). contents \\value{} now shown immediately \\arguments{}. default “branch” linking file sources HEAD, work regardless whether default branch called “main” “master”. Non-ORCID comments Authors@R now usable: comments exist, sidebar gains link authors page, displayed (#1516). Citations without text versions better handled, text citations correctly escaped HTML (@bastistician, #1507). README badges single paragraph placed <!-- badges: end --><!-- badges: end --> comments detected (#1603). 404 page (default .github/404.md) longer built development mode (see ?build_site) e.g. GitHub pages uses 404.html site root (#1622). links 404 pages (navbar, scripts, CSS) now absolute URL configuration file (#1622). version tooltip showed top navbar now set ’ve explicitly set development.mode _pkgdown.yml (#1768). heading (e.g. headings reference index page, arguments heading reference pages) now get anchors (#1747). Use autolink_bare_uris Pandoc version 2.0 (@marcosmolla, #1618). pkgdown now recognizes GitLab URLs source repository adds corresponding icon navbar (#1493). also supports GitLab subgroups (@salim-b, #1532). Links GitHub Enterprise GitLab Enterprise repositories detected assuming host address begin github. gitlab. (@ijlyttle, #1452). rules drawn CLI (example, build_site()) protected narrow terminal windows (@maxheld83, #1435). Google Site Verification (https://support.google.com/webmasters/answer/9008080?hl=en) can now configured pkgdown sites. build_rmarkdown_format sets html_document(anchor_sections = FALSE) avoid needless dependencies (@atusy, #1426). Jira issues NEWS can automatically linked setting project name repo: jira_projects: [...] specifying custom issue URL repo: url: issue: ... _pkgdown.yml (@jonkeane, #1466). build_home() always creates citation information authors page, using metadata DESCRIPTION inst/CITATION file, links sidebar (#1904). build_news() longer breaks URLs containing numeric fragments (@krassowski, #1456), recognises styles release heading (#1437), generate stable IDs using combination heading slug package number. (@Bisaloo, #1015)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-161","dir":"Changelog","previous_headings":"","what":"pkgdown 1.6.1","title":"pkgdown 1.6.1","text":"CRAN release: 2020-09-12 article index (used autolinking vignettes across packages) works (#1401).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-160","dir":"Changelog","previous_headings":"","what":"pkgdown 1.6.0","title":"pkgdown 1.6.0","text":"CRAN release: 2020-09-07","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"major-changes-1-6-0","dir":"Changelog","previous_headings":"","what":"Major changes","title":"pkgdown 1.6.0","text":"pkgdown now uses new downlit package syntax highlighting autolinking (reference topics vignettes). little change behaviour code downlit extracted pkgdown, makes easier use pkgdown’s nice linking/highlighting places (#1234). pkgdown now uses ragg::agg_png() device generate example figures. little faster produce higher quality output. Learn https://ragg.r-lib.org (#1320).","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"rd-translation-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Rd translation","title":"pkgdown 1.6.0","text":"\\special{} support inside \\usage{} added allow non-standard R usage syntax (@klmr, #1345). #ifdef #ifndef now supported; “current” OS hard coded “unix” ensure reproducible output regardless build website (#1384). Nested \\subsection{}s now generate appropriate heading levels (h3, h4, h5 etc) (#1377), get anchor links (#1389). \\preformatted{} longer double escapes contents (#1311).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-and-vignettes-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Articles and vignettes","title":"pkgdown 1.6.0","text":"build_articles() longer sets theme argument document format NULL as_is: true. allow work wider range output formats including bookdown::html_vignette2() friends (@GegznaV, #955, #1352). build_article() fails, gives complete failure message (#1379). Markdown header attributes now processed markdown files (@jonkeane, #1343)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"auto-linking-and-syntax-highlighting-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Auto-linking and syntax highlighting","title":"pkgdown 1.6.0","text":"branch used source linking can configured setting repo: branch: branch_name _pkgdown.yml (@jonkeane, #1355): autolink_html() (soft) deprecated. Please use downlit::downlit_html_path() instead. Highlighting empty expressions works (#1310). New deploy$install_metadata option _pkgdown.yml. Setting true store site metadata package , allowing offline access packages autolink package’s website (@mstr3336, #1336).","code":"repo:   branch: main"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Other","title":"pkgdown 1.6.0","text":"can now control background colour plots figures.bg option (transparent default, given white background css). See ?build_reference example. HTML automatically stripped page title (#1318). Suppressing CRAN dates news file now actually works. HTTP requests now retried upon failure (@jameslamb, #1305). Setting clean = TRUE deploy_site_github() removes old files deployed site building new one (#1297).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-151","dir":"Changelog","previous_headings":"","what":"pkgdown 1.5.1","title":"pkgdown 1.5.1","text":"CRAN release: 2020-04-09 Syntax highlighting works Windows (#1282). pkgdown longer fails .Rd files duplicated \\aliases produced older version roxygen2 (#1290). Rendering empty .md file now returns empty string (#1285). build_articles_index() now exported rapidly rebuild index (#1281) deploy_site_github() now accepts host argument specify alternate hosts (e.g., Github enterprise) (@dimagor, #1165) works intended Travis-CI (@jimhester, #1276).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-150","dir":"Changelog","previous_headings":"","what":"pkgdown 1.5.0","title":"pkgdown 1.5.0","text":"CRAN release: 2020-03-25","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-5-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.5.0","text":"articles index page navbar overhauled. two major new features release: articles index page now displays article descriptions, taken YAML metadata belonging article. lets provide context article describe one might want read (#1227). articles navbar now also controlled articles section _pkgdown.yml. ordering sections, articles within , control order articles navbar, can use new navbar field control whether section appears navbar (#1101, #1146). reference index now two levels heading hierarchy: title subtitle (#327). Tables contents sidebars now use bootstrap-toc; considerably improves navigation long articles reference pages. can now control links source files (reference pages articles) issues users (NEWS) new repo$url config option (#1238). makes easier use pkgdown GitHub enterprise, packages subdirectories, source hosts (like bitbucket). individual components (e.g. path, issue number, username) pasted end urls trailing /s. don’t need set links GitLab, pkgdown now detects GitLab urls automatically (since use structure GitHub) (#1045). ’s much richer control Open Graph Twitter metadata whole site individual articles. See new vignette(\"metadata\") details (@gadenbuie, #936). New deploy_to_branch() function build deploy site branch, defaulting gh-pages use GitHub Pages. used recommended GitHub action workflow automatically building deploying pkgdown sites packages GitHub (@jimhester, #1221). Updated JS libraries: jquery 3.3.1 -> 3.4.1; bootswatch 3.3.7 -> 3.4.0; bootstrap 3.3.7 -> bootstrap 3.4.1; docsearch 2.6.1 -> 2.6.3; fontawesome 5.11.1 -> 5.12.1; headroom.js 0.9.44 -> 0.11.0; clipboard.js 2.0.4 -> 2.0.6 (@jayhesselberth).","code":"repo:   url:     home: https://github.com/r-lib/pkgdown/     source: https://github.com/r-lib/pkgdown/blob/main/     issue: https://github.com/r-lib/pkgdown/issues/     user: https://github.com/"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"auto-linking-improvements-1-5-0","dir":"Changelog","previous_headings":"","what":"Auto-linking improvements","title":"pkgdown 1.5.0","text":"Examples Rmd now use exactly syntax highlighting strategy. examples Rmd, calls form current_package::foo now get local link (#1262). \\preformatted{} blocks now highlighted linked parse R code (#1180). library(pkgdown) now automatically linked reference index “pkgdown” documentation library() (#1161). help(\"topic\") now automatically linked documentation “topic”, documentation help() (#1210)","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Articles","title":"pkgdown 1.5.0","text":"build_home() longer uses (unrendered) README.Rmd index.Rmd corresponding .md files found. build_article() failures now print information help debug problem (#952). name vignette mapped “Get started” entry navbar now flexible. can use article (e.g articles/{pkgname}) package . name can replace - generate valid article name (e.g. get started vignette pack.pack-) (#1166).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"deployment-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Deployment","title":"pkgdown 1.5.0","text":"deploy_to_branch() now correctly captures commit SHA GitHub Actions (@coatless, #1252). deploy_to_branch(github_pages = TRUE) generates .nojekyll prevent jekyll ever executing (#1242). CNAME longer generated init_site(), instead conditionally deploy_to_branch() github_pages = TRUE. better fit CNAME file needed GitHub pages (#969). deploy_site_github() argument repo_slug deprecated longer needed used. (@jimhester, #1221)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"news-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"News","title":"pkgdown 1.5.0","text":"See additional details ?build_news: can optionally suppress CRAN release dates added news page (#1118). Multi-page news style gets better yaml specification (old style continue work need change existing YAML).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"reference-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Reference","title":"pkgdown 1.5.0","text":"topic named index longer clobber reference index (#1110). Topic names/aliases reference index now escaped (#1216). build_reference() gives better warnings _pkgdown.yml constructed incorrectly (#1025). New has_keyword() topic selector reference. has_keyword(\"datasets\") particularly useful selecting data documentation (#760). New lacks_concepts() can select topics contain number specified concepts. (@mikldk, #1232)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"home-authors-and-citation-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Home, authors, and citation","title":"pkgdown 1.5.0","text":"pkgdown now escapes html linkifies links comments author info DESCRIPTION (@maelle, #1204) pkgdown now uses ORCiD logo included Font Awesome 5.11 instead querying members.orcid.org (@bisaloo, #1153) badges now extracted everything <!--badges: start--> <!--badges: end-->. used extracted direct children first <p> <!--badges: start-->. build_home() now looks pkgdown/index.md addition top-level index README files (@nteetor, #1031)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"navbar-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Navbar","title":"pkgdown 1.5.0","text":"pkgdown now formats package version displayed navbar way specified DESCRIPTION file. particular, version separators (e.g. . -) preserved. (#1170, @kevinushey) add support navbar submenus: can create submenus following convention established rstudio/rmarkdown#721 (@ijlyttle, @wendtke, #1213)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Other","title":"pkgdown 1.5.0","text":"Updated JS libraries: jquery 3.3.1 -> 3.4.1; bootswatch 3.3.7 -> 3.4.0; bootstrap 3.3.7 -> bootstrap 3.4.1; docsearch 2.6.1 -> 2.6.3 (@jayhesselberth). Markdown conversion now explicitly allows markdown inside HTML blocks; previously accidentally disabled (#1220). timestamp last site build reported pkgdown.yml (#1122).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-141","dir":"Changelog","previous_headings":"","what":"pkgdown 1.4.1","title":"pkgdown 1.4.1","text":"CRAN release: 2019-09-14 Don’t install test package user library (fixes CRAN failure).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-140","dir":"Changelog","previous_headings":"","what":"pkgdown 1.4.0","title":"pkgdown 1.4.0","text":"CRAN release: 2019-09-03","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-4-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.4.0","text":"build citation specified textVersion argument citEntry CITATION file (#1096, @yiluheihei) build_site(), build_reference() build_home() gain parameter devel controls whether ’re deployment development mode. generalises replaces (deprecation) existing document argument. Development mode optimised rapid iteration default build_reference(). uses pkgload::load_all() load code directly disk order. Deployment mode slower, guarantees correct results, default build_site(). installs package temporary library, runs examples/articles new process. build_reference() longer runs devtools::document() (#1079) build_home() longer re-builds README.Rmd index.Rmd. makes scope responsibility pkgdown clear: now creates/modifies files doc/. build_home() now strips quotes Title Description fields generating page metadata. Additionally, can now override defaults via title description fields home section _pkgdown.yml (#957, @maelle). vignette(\"linking\") describes pkgdown’s automatic linking works, ensure cross-package links point right place.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"rd-translation-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Rd translation","title":"pkgdown 1.4.0","text":"\\examples{} rendering completely overhauled now first converts entire mixed Rd-R block R prior, evaluates whole thing. considerably improves fidelity translation small cost longer able remove \\donttest{} friends (#1087). \\item{}s \\describe{} containing whitespace translated correctly (#1117). \\dots \\ldots translated ... instead ellipsis, since ’re often found code (#1114). \\tabular{} translation handles code better (@mitchelloharawild, #978). \\subsection{} contents now treated paragraphs, inline text (#991). \\preformatted{} blocks preserve important whitespace (#951).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Front end","title":"pkgdown 1.4.0","text":"Links online documentation functions code chunks longer displayed printing (#1135, @bisaloo). Updated fontawesome v5.7.1. fontawesome 5 deprecated fa prefix. used custom icons navbar, ’ll update (e.g.) fa fa-home fas fa-home. Brands now separate prefix fa fa-github becomes fab fa-github (#953). navbar now automatically hidden headroom.js. sticky behaviour navbar now implemented pure CSS instead relying 3rd party javascript library (#1016, @bisaloo) Favicons now automatically built package logo (#949).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"linking-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Linking","title":"pkgdown 1.4.0","text":"Infix operators (e.g., %% %*%) now linked documentation (#1082). Function names can now included headers without spurious auto-linking (#948). Links external documentation now point rdrr.io (#998).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Other","title":"pkgdown 1.4.0","text":"News page recognises version specifications (including “(development version)” now used usethis) (#980). Subdirectories supported assets (#939, @ijlyttle). default 404 page (404.html) built, unless custom .github/404.md provided (#947). build_article() now uses raw vignette title page <title> og:title (@maelle, #1037). build_home() now looks license files spelled either LICENSE LICENCE (#972). build_home() can find badges paragraph coming comment <!-- badges: start --> (#670, @gaborcsardi, @maelle). build_home() add community section sidebar either code conduct (.github/CODE_OF_CONDUCT.md) contributing guide (.github/CONTRIBUTING.md) (#1044, @maelle). build_reference() gains topics argument allows re-build specified topics. build_site(new_process = TRUE) gains timeout, options(pkgdown.timeout = 10), can used prevent stalled builds. deploy_site_github(install = FALSE) makes possible opt installation. dev_mode() now recognises 0.1.9000 development version package (emerging standard use packages backward incompatible changes) (#1101).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-130","dir":"Changelog","previous_headings":"","what":"pkgdown 1.3.0","title":"pkgdown 1.3.0","text":"CRAN release: 2018-12-06 Restore accidentally deleted build_logo() function logos copied website. Fix pkgdown.css page header correct amount top margin. content-home.html template longer used homepage .Rmd (Reverts #834. Fixes #927, #929) deploy_site_github() now passes parameters build_site() (@noamross, #922), documentation gives slightly better advice. Correct --one error navbar highlighting javascript; now navbar highlighted none match current path (#911). Tweaking HTML table classes fixed (@yonicd, #912) Restore accidentally removed docsearch.css file.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-120","dir":"Changelog","previous_headings":"","what":"pkgdown 1.2.0","title":"pkgdown 1.2.0","text":"CRAN release: 2018-11-20","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.2.0","text":"deploy_site_github() can used continuous integration systems (like travis) automatically deploy package website GitHub Pages. See documentation set details (@jimhester). build_favicon() creates high resolution favicons package logo, saves pkgdown/. created using https://realfavicongenerator.net/ API, better suited modern web usage (e.g. retina display screens, desktop shortcuts, etc.). also removes dependency magick package, making automated deployment little easier (@bisaloo, #883). Users limited internet connectivity can explicitly disable internet usage pkgdown setting options(pkgdown.internet = FALSE) (#774, #877).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"improvements-to-rd-translation-1-2-0","dir":"Changelog","previous_headings":"","what":"Improvements to Rd translation","title":"pkgdown 1.2.0","text":"rd2html() now exported facilitate creation translation reprexes. \\Sexpr{} conversion supports multiple arguments, eliminating x must string R connection errors using \\doi{} (#738). \\tabular{} conversion better handles empty cells (#780). \\usage{} now supports qualified functions eliminatingError fun_info(x) : Unknown call: :: errors (#795). Invalid tags now generate informative errors (@BarkleyBG, #771, #891)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-2-0","dir":"Changelog","previous_headings":"","what":"Front end","title":"pkgdown 1.2.0","text":"default footer now displays version pkgdown used build site (#876). third party resources now fetched single CDN give SRI hash (@bisaloo, #893). navbar version now class “version” can easily control display (#680). default css tweaked ensure icons visible browsers (#852).","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"home-page-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Home page","title":"pkgdown 1.2.0","text":"Can now build sites older packages don’t Authors@R field (#727). Remote urls ending .md longer tweaked end .html (#763). Bug report link shown ’s “BugReports” field (#855). content-home.html template now used homepage .Rmd (@goldingn, #787). link source inst/CITATION added authors page (#714).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"news-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"News","title":"pkgdown 1.2.0","text":"Uses stricter regular expression linking GitHub authors (#902).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"reference-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Reference","title":"pkgdown 1.2.0","text":"Unexported functions test helpers longer loaded (#789). Selectors match topics now generate warning. none specified selectors match, topics selected (#728).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Articles","title":"pkgdown 1.2.0","text":"display depth vignette tables contents can configured setting toc: depth _pkgdown.yml (#821):","code":"toc:   depth: 2"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"overall-site-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Overall site","title":"pkgdown 1.2.0","text":"init_site() now creates CNAME file one doesn’t already exist site’s metadata includes url field. build_site() loses vestigal mathjax parameter. didn’t appear anything one remember existed (#785). build_site() now uses colours even new_process = TRUE (@jimhester).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-110","dir":"Changelog","previous_headings":"","what":"pkgdown 1.1.0","title":"pkgdown 1.1.0","text":"CRAN release: 2018-06-02","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-1-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.1.0","text":"build_reference() build_site() get new document argument. TRUE, default, automatically run devtools::document() ensure documentation date. build_site() gains new_process argument, defaults TRUE. run pkgdown separate process, recommended practice improves reproducibility (#647). Improved display icons: icons must 30px stored top-level icons/ directory. embedded separate column reference index table, instead inside comment (!) (#607).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-1-0","dir":"Changelog","previous_headings":"","what":"Front end","title":"pkgdown 1.1.0","text":"Added keyboard shortcut searching. Press shift + / (?) move focus search bar (#642). Algolia logo correctly shown search results (#673). Navbar active tab highlighting uses superior approach (suggested mean active page correctly highlighted scenarios (#660). pkgdown.js better isolated still work even load html widgets import different version jquery (#655).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"improvements-to-rd-translation-1-1-0","dir":"Changelog","previous_headings":"","what":"Improvements to Rd translation","title":"pkgdown 1.1.0","text":"vignette() calls don’t link existing vignettes silently fail link instead generating uninformative error messages (#652). Automatic linking works re-exported objects functions (@gaborcsardi, #666). Empty \\section{}s ignored (#656). Previously, empty sections caused error Error rep(TRUE, length(x) - 1). \\Sexpr{} supports results=text, results=Rd results=hide (#651). \\tabular{} longer requires terminal \\cr (#664, #645).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"minor-bug-fixes-and-improvements-1-1-0","dir":"Changelog","previous_headings":"","what":"Minor bug fixes and improvements","title":"pkgdown 1.1.0","text":"Add inst/pkgdown.yml possible site configuration file packages CRAN can built without needing development version (#662). Default navbar template now uses site title, package name (package name default title, affect sites) (#654). can suppress indexing search engines setting noindex: true pkgdown.yml (#686) build_article() sets IN_PKGDOWN env var in_pkgdown() works (#650). build_home(): CITATION files non-UTF-8 encodings (latin1) work correctly, instead generating error. non-UTF-8 locales, ensure e.g. Encoding: latin1 DESCRIPTION; best practice re-enode CITATION file UTF-8 (#689). build_home(): Markdown files (e.g., CODE_OF_CONDUCT.md) stored .github/ copied linked correctly (#682). build_news(): Multi-page changelogs (generated NEWS.md news: one_page: false _pkgdown.yml) rendered correctly. build_reference(): reference index shows infix functions (like %+%) `%+%`, `%+%`() (#659).","code":"template:   params:     noindex: true"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-100","dir":"Changelog","previous_headings":"","what":"pkgdown 1.0.0","title":"pkgdown 1.0.0","text":"CRAN release: 2018-05-03 Major refactoring path handling. build_ functions longer take path depth arguments. Instead, set destination directory top level pkgdown.yml. Similarly, build_news() longer takes one_page argument; now specified _pkgdown.yml instead. See documentation example.","code":""}]
+[{"path":"https://pkgdown.r-lib.org/dev/CODE_OF_CONDUCT.html","id":null,"dir":"","previous_headings":"","what":"Contributor Code of Conduct","title":"Contributor Code of Conduct","text":"contributors maintainers project, pledge respect people contribute reporting issues, posting feature requests, updating documentation, submitting pull requests patches, activities. committed making participation project harassment-free experience everyone, regardless level experience, gender, gender identity expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion. Examples unacceptable behavior participants include use sexual language imagery, derogatory comments personal attacks, trolling, public private harassment, insults, unprofessional conduct. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct. Project maintainers follow Code Conduct may removed project team. Instances abusive, harassing, otherwise unacceptable behavior may reported opening issue contacting one project maintainers. Code Conduct adapted Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available http://contributor-covenant.org/version/1/0/0/","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to pkgdown","title":"Contributing to pkgdown","text":"document outlines propose change pkgdown. detailed info contributing tidyverse packages, please see tidyverse contribution guide.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"pkgdown-and-pandoc-versions","dir":"","previous_headings":"","what":"pkgdown and Pandoc versions","title":"Contributing to pkgdown","text":"versions pkgdown Pandoc used build website stored public facing pkgdown.yml file, e.g. https://dplyr.tidyverse.org/pkgdown.yml.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"package-reprexes","dir":"","previous_headings":"","what":"Package reprexes","title":"Contributing to pkgdown","text":"encounter unexpected errors running pkgdown::build_site(), try build minimal package recreates error. ideal minimal package dependencies, making easy install quickly reproduce error. example minimal package issue, minimal package containing single .R file two lines reproduce error. quickest way set minimal example package usethis::create_package(): built minimal package recreates error, create GitHub repository package (e.g. usethis::use_git() + usethis::use_github()), file issue link repository.","code":"usethis::create_package(\"~/desktop/testpackage\") # ... edit files ... pkgdown::build_site(tmp, new_process = FALSE, preview = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"rd-translation","dir":"","previous_headings":"","what":"Rd translation","title":"Contributing to pkgdown","text":"encounter problems Rd tags, please use rd2html() create reprexes:","code":"library(pkgdown)  rd2html(\"a\\n%b\\nc\") rd2html(\"a & b\")"},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"","what":"Pull request process","title":"Contributing to pkgdown","text":"recommend create Git branch pull request (PR). Look Travis AppVeyor build status making changes. README contain badges continuous integration services used package. New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat. Contributions test cases included easier accept. user-facing changes, add bullet top NEWS.md current development version header describing changes made followed GitHub username, links relevant issue(s)/PR(s).","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"netlify","dir":"","previous_headings":"Pull request process","what":"Netlify","title":"Contributing to pkgdown","text":"might ask Netlify preview changes .e. local changes affect pkgdown website? Build install amended package, re-build website (clean_site() build_site()) update docs/ folder. Log Netlify https://app.netlify.com/sites/, scroll bottom. ’ll see box dashed outline says “Want deploy new site without connecting Git?”. Open file browser, navigate docs/, drag docs/ folder dashed box, copy files temporary netlify site. file transfer completes, netlify generate temporary URL new page can copy/paste PR discussion.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to pkgdown","text":"Small typos grammatical errors documentation may edited directly using GitHub web interface, long changes made source file. YES: edit roxygen comment .R file R/. : edit .Rd file man/.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"prerequisites","dir":"","previous_headings":"","what":"Prerequisites","title":"Contributing to pkgdown","text":"make substantial pull request, always file issue make sure someone team agrees ’s problem. ’ve found bug, create associated issue illustrate bug minimal reprex.","code":""},{"path":"https://pkgdown.r-lib.org/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to pkgdown","text":"Please note pkgdown project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://pkgdown.r-lib.org/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2023 pkgdown authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting started","title":"Customise your site","text":"theming features work Bootstrap 5, first update site adding following lines _pkgdown.yml: Overall, site look pretty similar, notice number small improvements. importantly, default font much bigger, making considerably easier read. Upgrading Bootstrap 5 low chance breaking site unless using pkgdown templates custom CSS.","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"theming","dir":"Articles","previous_headings":"","what":"Theming","title":"Customise your site","text":"two ways change visual style site _pkgdown.yml: using pre-packaged bootswatch theme customising theme variables bslib. following sections show .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"bootswatch-themes","dir":"Articles","previous_headings":"Theming","what":"Bootswatch themes","title":"Customise your site","text":"easiest way change entire appearance website use Bootswatch theme: Changing bootswatch theme affects HTML (via navbar, ) CSS, ’ll need re-build complete site build_site() fully appreciate changes. ’re experimenting, can speed things just rebuilding home page CSS running build_home_index(); init_site() (refreshing browser). Bootswatch templates tall navbars (e.g. lux, pulse) also require set pkgdown-nav-height bslib variable. Bootswatch themes provided bslib R package, can also nest bootswatch field bslib field. can find correct height running $(\".navbar\").outerHeight() javascript console.","code":"template:   bootstrap: 5   bootswatch: materia template:   bootstrap: 5   bslib:     bootswatch: lux     pkgdown-nav-height: 100px"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"bslib-variables","dir":"Articles","previous_headings":"Theming","what":"bslib variables","title":"Customise your site","text":"Instead picking complete theme, can tweak fonts colours individually using bslib variables. bslib R package wraps sass, tool Boostrap uses produce CSS special language called scss. primary advantage scss CSS ’s programmable, can key bslib variables affect appearance many HTML elements. three key variables affect colour: bg (background) determines page background. fg (foreground) determines text colour. bg fg mixed yield gray-100, gray-200, …, grey-900, used style elements match overall colour scheme. primary sets link colour (translucent) hover colour navbar sidebar. can customise components setting specific bslib variables, taking advantage inheritance possible. example, table-border-color defaults border-color defaults gray-300. want change colour borders, can set border-color; just want change colour table borders, can set table-border-color. can find full list variables vignette(\"bs5-variables\", package = \"bslib\"). can also override default fonts used majority text (base_font), headings (heading_font) code (code_font). easiest way supply name Google font: iterating colours variables need rerun init_site() refresh browser; iterating fonts, ’ll need run build_home_index(); init_site(). Theming bslib powered bslib::bs_theme() bslib field direct translation arguments function. result, can fully specify bslib theme using template.bslib field, making easy share YAML output.html_document.theme field R Markdown document.","code":"template:   bootstrap: 5   bslib:     bg: \"#202123\"     fg: \"#B8BCC2\"     primary: \"#306cc9\" template:   bootstrap: 5   bslib:     base_font: {google: \"Roboto\"}     heading_font: {google: \"Roboto Slab\"}     code_font: {google: \"JetBrains Mono\"} template:   bslib:     version: 5     bootswatch: lux     base_font: {google: \"Roboto\"}     heading_font: {google: \"Roboto Slab\"}     code_font: {google: \"JetBrains Mono\"}"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"syntax-highlighting","dir":"Articles","previous_headings":"Theming","what":"Syntax highlighting","title":"Customise your site","text":"colours used syntax highlighting code blocks controlled theme setting: can choose following options: a11y-dark, a11y-light, arrow-dark, arrow-light, atom-one-dark, atom-one-light, ayu-dark, ayu-light, ayu-mirage, breeze-dark, breeze-light, breezedark, dracula, espresso, github-dark, github-light, gruvbox-dark, gruvbox-light, haddock, kate, monochrome-dark, monochrome-light, monochrome, monokai, nord, oblivion, printing, pygments, radical, solarized-dark, solarized-light, solarized, tango, vim-dark, zenburn. Bootswatch themes dark background (e.g. cyborg, darkly, solar) need dark syntax highlighting theme, e.g. arrow-dark: foreground background colours used inline code controlled code-color code-bg bslib variables. want inline code match code blocks, ’ll need override variables , e.g.:","code":"template:   bootstrap: 5   theme: breeze-light template:   bootstrap: 5   bootswatch: cyborg   theme: arrow-dark template:    bootstrap: 5   theme: arrow-dark     bslib:     code-bg: \"#2b2b2b\""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"navbar-style","dir":"Articles","previous_headings":"Theming","what":"Navbar style","title":"Customise your site","text":"primary navbar colours determined HTML classes, CSS, can customized using navbar fields bg type control background foreground colours respectively. Typically bg one light, dark, primary: generally don’t need set bg use bootswatch theme, pkgdown pick bg used Bootstwatch preview. Similarly, don’t usually need set type bootstrap guess . guesses wrong, override type: light type: dark depending whether background colour light (need dark text) type: dark background dark (need light text). Unfortunately, defined relative page background, dark site ’ll need flip light dark (little experimentation quickly determine looks best). navbar styled HTML, ’ll need build_home_index(); init_site() see effect changing parameter.","code":"navbar:   bg: primary"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"layout","dir":"Articles","previous_headings":"","what":"Layout","title":"Customise your site","text":"can customise contents navbar, footer, home page sidebar using navbar, footer, sidebar fields. use similar structure separately defines overall structure individual components.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"navbar-heading","dir":"Articles","previous_headings":"Layout","what":"Navbar","title":"Customise your site","text":"can customise navigation bar appears top page navbar field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: makes use six built-components: intro: “Get Started”, links vignette article name package1. reference, .Rd files. articles, vignettes articles. tutorials, tutorials. news, NEWS.md exists. search, search box (see vignette(\"search\") details). github, link source repository (icon), can automatically determined DESCRIPTION. can use structure field reorganise navbar without changing default contents: can use components override default content. example, yaml provides custom articles menu: Components uses syntax RMarkdown menus. elements menu can : link (text + href) heading (just text) separator (text: ——–) Instead text, can also use name icons fontawesome. also provide textual description aria-label field screenreader users. add new component navbar, need modify structure components. example, following yaml adds new “twitter” component appears left github icon. Finally, can add arbitrary HTML three locations navbar: includes appear screen sizes, collapsed navbar drop . can also customise colour scheme navbar using type bg parameters. See details.","code":"navbar:   structure:     left:  [intro, reference, articles, tutorials, news]     right: [search, github] navbar:   structure:     left:  [search]     right: [reference, articles] navbar:  components:    articles:     text: Articles     menu:     - text: Category A     - text: Title A1       href: articles/a1.html     - text: Title A2       href: articles/a2.html     - text: -------     - text: \"Category B\"     - text: Article B1       href: articles/b1.html navbar:   structure:     right: [twitter, github]   components:     twitter:       icon: fa-twitter       href: http://twitter.com/hadleywickham       aria-label: Twitter template:   includes:     before_title: <!-- inserted before the package title in the header ->     before_navbar: <!-- inserted before the navbar links -->     after_navbar: <!-- inserted after the navbar links -->"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"footer","dir":"Articles","previous_headings":"Layout","what":"Footer","title":"Customise your site","text":"can customise footer footer field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: uses two three built-components: developed_by, sentence describing main authors package. (See ?build_home want tweak authors appear footer.) built_with, sentence advertising pkgdown. package, name package. can override defaults footer field. example puts authors’ information right along legal disclaimer, puts pkgdown link left. side pasted single string (separated \" \") converted markdown HTML.","code":"footer:   structure:      left: developed_by     right: built_with footer:   structure:      left: pkgdown     right: [developed_by, legal]   components:     legal: Provided without **any warranty**."},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"sidebar","dir":"Articles","previous_headings":"Layout","what":"Sidebar","title":"Customise your site","text":"can customise homepage sidebar home.sidebar field. ’s made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure: drawn seven built-components: links: automated links generated URL BugReports fields DESCRIPTION plus manual links home.links field: license: Licensing information LICENSE/LICENCE LICENSE.md/LICENCE.md files present. community: links .github/CONTRIBUTING.md, .github/CODE_OF_CONDUCT.md, etc. citation: link package citation information. Uses either inst/CITATION , absent, information DESCRIPTION. authors: selected authors DESCRIPTION. dev: development status badges extracted README.md/index.md. shown “development” versions websites; see “Development mode” ?build_site details. toc: table contents README (shown default). can also add components, text markdown text: Alternatively, can provide ready-made sidebar HTML: completely remove :","code":"home:   sidebar:     structure: [links, license, community, citation, authors, dev] home:   links:   - text: Link text     href: https://website.com   - text: Roadmap     href: /roadmap.html home:   sidebar:     structure: [authors, custom, toc, dev]     components:       custom:         title: Funding         text: We are *grateful* for funding! home:   sidebar:     html: path-to-sidebar.html home:   sidebar: FALSE"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"additional-html-and-files","dir":"Articles","previous_headings":"","what":"Additional HTML and files","title":"Customise your site","text":"need include additional HTML, can add following locations: can include additional files putting right place: pkgdown/extra.css pkgdown/extra.js copied rendered site linked <head> (pkgdown defaults). pkgdown/extra.scss added scss ruleset used generate site CSS. files pkgdown/assets copied website root directory. expert users: template files pkgdown/templates override layout templates provided pkgdown template packages. Use init_site() update rendered website making changes files.","code":"template:   includes:     in_header: <!-- inserted at the end of the head -->     before_body: <!-- inserted at the beginning of the body -->     after_body: <!-- inserted at the end of the body -->     before_title: <!-- inserted before the package title in the header ->     before_navbar: <!-- inserted before the navbar links -->     after_navbar: <!-- inserted after the navbar links -->"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"template-packages","dir":"Articles","previous_headings":"","what":"Template packages","title":"Customise your site","text":"share pkgdown style across several packages, best workflow create… package! can contain following: configuration file inst/pkgdown/_pkgdown.yml. can used set (e.g.) author definitions, Bootstrap version variables, sidebar, footer, navbar, etc. Templates inst/pkgdown/templates/ override default templates. Assets inst/pkgdown/assets/ copied destination directory. inst/pkgdown/extra.scss added bslib ruleset. configuration/files supplied override pkgdown defaults, overridden site specific settings. created template package theverybest, can use : Setting sites theme: ’re building site using GitHub actions similar tool, ’ll also need installed theverybest. ’re using r-lib pkgdown workflow, can add following line DESCRIPTION: get sense theming package works, can look : tidytemplate used tidyverse tidymodels packages; quillt used R Markdown packages; rotemplate used rOpenSci packages. please note templates aren’t suitable use package ’re designed give common visual identity specific family packages.","code":"template:   package: theverybest Config/Needs/website: theverybest"},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"porting-a-template-package","dir":"Articles","previous_headings":"Template packages","what":"Porting a template package","title":"Customise your site","text":"updating template package works pkgdown 1.0.0, create directories inst/pkgdown/BS5/templates inst/pkgdown/BS5/assets (don’t templates/assets make sure add dummy file ensure git tracks ). templates assets directories directly inst/pkgdown used pkgdown 1.0.0 pkgdown 2.0.0 boostrap: 3. directories inst/pkgdown/BS5/ used pkgdown 2.0.0 boostrap: 5. lets package support versions bootstrap pkgdown.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"pr-previews","dir":"Articles","previous_headings":"","what":"PR previews","title":"Customise your site","text":"Lastly, might useful get preview website internal pull requests. , use Netlify GitHub Actions (apply similar logic toolset): Create new Netlify website (either scratch dragging dropping simple index.html, creating site GitHub repository unlinking repository); site settings get ID saved NETLIFY_SITE_ID repo secrets; account developer settings get token saved NETLIFY_AUTH_TOKEN repo secrets. Starting standard pkgdown workflow usethis::use_github_action(\"pkgdown\"), add logic build site deploy Netlify pull requests inside repository, pull requests forks. Example workflow.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/customise.html","id":"conclusion","dir":"Articles","previous_headings":"","what":"Conclusion","title":"Customise your site","text":"vignette explained change theming layout pkgdown websites. work improve user experience involve: Working article (?build_articles) reference indexes (?build_reference). Writing compelling README explains package cool/useful/fun. Improving contents individual articles reference topics 😉.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"process","dir":"Articles","previous_headings":"","what":"Process","title":"How to update a released site","text":"’re speed basic idea just want code follow, . Otherwise, read .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"setup","dir":"Articles","previous_headings":"Process","what":"Setup","title":"How to update a released site","text":"First, make sure ’re main branch, latest version: Next figure released version ’re updating: ’ll use create checkout branch ’ll work :","code":"gert::git_branch_checkout(\"main\") gert::git_pull() ver <- desc::desc_get_version()[1, 1:3] gert::git_branch_create(paste0(\"pkgdown-v\", ver), paste0(\"v\", ver))"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"backport-changes","dir":"Articles","previous_headings":"Process","what":"Backport changes","title":"How to update a released site","text":"Now need backport changes dev site branch. Run R code generate git code pull changes common locations: backport DESCRIPTION, ’ll also need undo change Version: Now build site locally check looks expect:","code":"files <- c(   # overall site config    \"_pkgdown.yml\",   # the workflow that builds the site   \".github/workflows/pkgdown.yaml\",   # readme and vignettes   \"README.md\", \"vignettes\",   # logo and favicon   \"man/figures/\", \"pkgdown/\",    # Author metadata and Config/Needs/Website   \"DESCRIPTION\" )  glue::glue(\"git checkout v{ver} -- {files}\") desc::desc_set_version(ver) pkgdown::build_site()"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"publish","dir":"Articles","previous_headings":"Process","what":"Publish","title":"How to update a released site","text":"Now need publish site. First push branch GitHub: trigger pkgdown workflow: Go package’s GHA page, e.g. usethis::browse_github_actions()). Select pkgdown workflow. Click Run workflow select branch just pushed. ’s dropdown menu , means pkgdown workflow config current.","code":"usethis:::git_push_first()"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"context","dir":"Articles","previous_headings":"","what":"Context","title":"How to update a released site","text":"talk update released site, first establish might need . released site? kind pkgdown site ? updating released site take special effort?","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"automatic-development-mode","dir":"Articles","previous_headings":"Context","what":"Automatic development mode","title":"How to update a released site","text":"Every pkgdown site -called development mode, can specified via development field _pkgdown.yml. unspecified, default mode: release, results single pkgdown site. Despite name, single site reflects “current package state”, either released state development state. packages substantial user base, recommended instead specify mode: auto like : directs pkgdown “generate different sites development released versions package.” readr package demonstrates happens automatic development mode: readr.tidyverse.org documents released version, .e. install.packages() deliver.readr.tidyverse.org/dev/ documents dev version, .e. ’d get installing GitHub. mode, pkgdown::build_site(), consults DESCRIPTION learn package’s version number. development version number, rendered site written docs/dev/. released version number, site written docs/. (also signals alert users reading documentation dev version vs. released version.) Automatic development mode recommended packages broad user base, maximizes chance user read web-based documentation reflects package version locally installed.","code":"development:   mode: auto"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"publishing","dir":"Articles","previous_headings":"Context","what":"Publishing","title":"How to update a released site","text":"Now ’ve established meaning released (vs dev) site, consider site built (.e. HTML generated) deployed (.e. HTML published website people can see .). recommend usethis::use_pkgdown_github_pages() basic pkgdown setup configure GitHub Actions (GHA) workflow automatically render publish site GitHub Pages. function bascially shortcut calling following functions individually: use_pkgdown() use_github_pages() use_github_action(\"pkgdown\") adds pkgdown site’s URL _pkgdown.yml, URL field DESCRIPTION, GitHub repo. result, publishing cadence many pkgdown sites governed workflow maintained r-lib/actions/examples/pkgdown.yaml. (confuse _pkgdown.yml, gives instructions pkgdown package, .github/workflows/pkgdown.yaml, gives instructions GHA.) important bits GHA workflow config: Altogether means : Build deploy pushes main. Build, don’t deploy, pull requests main. reveals pkgdown errors, ensures live site isn’t updated pull request merged (code pushed main). Build deploy publish GitHub release. convention, assume GitHub release coincides CRAN release. primary mechanism building released pkgdown site. pkgdown::build_site_github_pages() consults version DESCRIPTION detect whether ’s building released version dev version. determines dest_dir, e.g. docs/ released docs/dev/ dev. package automatic development mode, means almost pushes trigger update dev site. released site updated push state non-development version number publish GitHub release. tweak things released site releases? brings us workflow_dispatch:. (Yes dangling colon correct.) inclusion workflow_dispatch trigger means pkgdown workflow can run demand, importantly browser.","code":"on:   push:     branches: [main, master]   pull_request:     branches: [main, master]   release:     types: [published]   workflow_dispatch:    <snip, snip>        - name: Build site         run: Rscript -e 'pkgdown::build_site_github_pages(...)'                - name: Deploy to GitHub pages 🚀         if: github.event_name != 'pull_request'         uses: JamesIves/github-pages-deploy-action@4.1.4                  <snip, snip>"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"construct-a-branch-for-the-update","dir":"Articles","previous_headings":"","what":"Construct a branch for the update","title":"How to update a released site","text":"overall goal create branch combines features released website (e.g. released version) development version (e.g. improvements _pkgdown.yml). easiest way start branch using latest release tag, bring selected changes files development version. example, readr’s latest release 2.1.1: general pattern: Now port innovations development site want apply released site. Files must update: .github/workflows/pkgdown.yaml _pkgdown.yml Config/Needs/website field DESCRIPTION (, probably, field! particular, mess version number.) likely candidates: README.Rmd + README.md, e.g., ’ve updated badges. documentation fixes apply released version. reason touch anything R/ even affect roxygen comments. Don’t forget document() ! new vignettes articles apply released version. tips backporting specific changes branch. lucky, specific commits default branch contain necessary changes. case, can cherry pick commit SHA: doesn’t cover everything, file want update, identify Git reference (meaning: SHA, tag, branch) file desired state. Checkout specific file path specific ref: example, readr recently gained new vignette applies released version readr, .e. document dev-features functions. can bring current branch : Commit push new branch GitHub. usethis::pr_push() can handy . Just don’t bother opening pull request (branch still pushed). Now use workflow_dispatch GHA trigger: Go Actions page repo, maybe via usethis::browse_github_actions(). Click pkgdown workflow. Click “Run workflow”. “Use workflow ” dropdown menu, select branch ’ve just made pushed, click “Run workflow”. kick pkgdown build--deploy , specifically, cause updates released site. can keep branch around , case didn’t get everything right first time things crop ’d like backport released site, next CRAN release.","code":"git checkout -b update-pkgdown-2-1-1 v2.1.1 git checkout -b NEW-BRANCH-NAME NAME-OF-RELEASE-TAG git cherry-pick SHA git checkout main -- path/to/the/file git checkout main -- vignettes/column-types.Rmd"},{"path":"https://pkgdown.r-lib.org/dev/articles/how-to-update-released-site.html","id":"problem-solving","dir":"Articles","previous_headings":"","what":"Problem-solving","title":"How to update a released site","text":"Another great problem solving technique get bunch people’s _pkgdown.yml files front eyeballs. two ways : GitHub search Michael Chirico’s r-ci-samples repo. given _pkgdown.yml file, remember History Blame can helpful seeing evolved time.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/linking.html","id":"within-a-package","dir":"Articles","previous_headings":"","what":"Within a package","title":"Auto-linking","text":"pkgdown automatically link documentation articles wherever ’s possible unambiguously. includes: Bare function calls, like build_site(). Calls ?, like ?build_site package?pkgdown. Calls help(), like help(\"pkgdown\"). Calls vignette(), like vignette(\"pkgdown\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/linking.html","id":"across-packages","dir":"Articles","previous_headings":"","what":"Across packages","title":"Auto-linking","text":"Linking documentation another package straightforward. Just adapt call usual way: purrr::map(), MASS::addterm(). ?purrr::map, ?MASS::addterm. vignette(\"-langs\", package = \"purrr\"), vignette(\"longintro\", package = \"rpart\") purrr pkgdown can find pkgdown site remote package, link ; otherwise, link https://rdrr.io/ documentation CRAN vignettes. order pkgdown site findable, needs listed two places: URL field DESCRIPTION, dplyr: url field _pkgdown.yml, dplyr field defined, pkgdown generate public facing pkgdown.yml file provides metadata site: Now, build pkgdown site package links dplyr documentation (e.g., dplyr::mutate()), pkgdown looks first dplyr’s DESCRIPTION find website, looks pkgdown.yml, uses metadata generate correct links. allow package linked locally installed packages, even website reachable build time, following option needs set _pkgdown.yml: allows locally installed packages access package index metadata locally installed copy, may useful website require auth, build behind firewall.","code":"URL: https://dplyr.tidyverse.org, https://github.com/tidyverse/dplyr url: https://dplyr.tidyverse.org pandoc: '2.2' pkgdown: 1.3.0 pkgdown_sha: ~ articles:   compatibility: compatibility.html   dplyr: dplyr.html   dplyr_0.8.0: future/dplyr_0.8.0.html   dplyr_0.8.0_new_hybrid: future/dplyr_0.8.0_new_hybrid.html   programming: programming.html   two-table: two-table.html   window-functions: window-functions.html urls:   reference: https://dplyr.tidyverse.org/reference   article: https://dplyr.tidyverse.org/articles deploy:   install_metadata: true"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"necessary-configuration","dir":"Articles","previous_headings":"","what":"Necessary configuration","title":"Metadata","text":"Metadata can produced correctly pkgdown website URL indicated configuration file.","code":"url: https://example.com"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"site-wide-customization","dir":"Articles","previous_headings":"","what":"Site-wide customization","title":"Metadata","text":"Metadata entire pkgdown website can specified site’s _pkgdown.yml configuration file home template: opengraph sections: home: title home: description fields override Title Description fields package DESCRIPTION. ’s good practice set fields make package documentation easier find via search, rather sticking title description needed CRAN. template: opengraph section allows customize social media card. image: default, pkgdown uses package’s logo card image (one exists). Use image specify alternative image social media cards pages pkgdown site. src: fully qualified URL media card image e.g. src: https://avatars.githubusercontent.com/u/22618716?v=4; relative path image rendered website e.g. src: articles/test/image.jpg; relative path image stored man/figures package e.g. src: man/figures/cards.png. src field required image specified. alt: Alternative text describing image screen readers situations social media card image displayed. twitter: can specify Twitter accounts associated package style social media card Twitter display. creator: Typically, Twitter handle author package article. site: Twitter handle organization affiliated package author sponsoring package development. one creator site included, provided value used fields. card: style social media card Twitter display. pkgdown sites, relevant options summary_large_image, featuring large image page title description, summary, featuring small square image inline left page title description.","code":"home:   title: An R package for pool-noodle discovery   description: Discover and add pool-noodles to your growing collection.    template:   opengraph:     image:       src: man/figures/card.png       alt: \"Pool noodles configured to form the word poolnoodlr\"     twitter:       creator: \"@hadleywickham\"       site: \"@rstudio\"       card: summary_large_image"},{"path":"https://pkgdown.r-lib.org/dev/articles/metadata.html","id":"article-metadata","dir":"Articles","previous_headings":"","what":"Article metadata","title":"Metadata","text":"Articles vignettes rendered articles pkgdown can individually customized metadata social media cards. Use title, description, author fields specify title, description, (optional) author vignette article. title field used title article pkgdown site always included. title description used pkgdown page’s social media card. description included article’s YAML front matter, name package used instead. description also displayed articles index. author field used text vignette article. author name displayed depends output format. articles, opengraph section works way site-wide template: opengraph settings, applied article vignette. allows specify social media card preview images individual articles, associate article particular Twitter account. specified, opengraph settings site-wide configuration used.","code":"title: \"Introduction to poolnoodlr\" description: \"A brief introduction to pool noodles in R.\" author: \"Mara Averick\" opengraph:   image:      src: \"https://example.com/pkg/batpig.png\"   twitter:     card: summary     creator: \"@dataandme\" output: rmarkdown::html_vignette vignette: >   %\\VignetteIndexEntry{Introduction to poolnoodlr}   %\\VignetteEngine{knitr::rmarkdown}   %\\VignetteEncoding{UTF-8}"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"metadata","dir":"Articles","previous_headings":"","what":"Metadata","title":"Introduction to pkgdown","text":"can override pkgdown’s defaults YAML file called _pkgdown.yml1. important field url, gives final location site: url used throughout site generate absolute urls needed. url also part enables auto-links help topics vignettes sites external package, pkgdown sites Quarto websites. See vignette(\"linking\") . Another important option template, allows control overall appearance site: can learn controlling appearance site vignette(\"customise\").","code":"url: https://pkgdown.r-lib.org template:   bootstrap: 5   bootswatch: cerulean"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"language","dir":"Articles","previous_headings":"Metadata","what":"Language","title":"Introduction to pkgdown","text":"documentation (.Rd .Rmd) written language English, declare setting setting lang two letter language code language: used set language web page translate English words pkgdown generates site. Current available translations : ca: Catalan de: German dk: Danish es: Spanish fr: French ko: Korean pt: Portuguese tr: Turkish zh_CN: Chinese (simplified)","code":"lang: fr"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"home-page","dir":"Articles","previous_headings":"","what":"Home page","title":"Introduction to pkgdown","text":"contents home page automatically generated index.md README.md. pkgdown tries order, ’s possible different display GitHub pkgdown providing files. homepage also includes sidebar full useful links; see ?build_home generated can customise .","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"reference","dir":"Articles","previous_headings":"","what":"Reference","title":"Introduction to pkgdown","text":"pkgdown creates function reference reference/ includes one page .Rd help topic man/. translation individual help topics Rd HTML generally straightforward, couple things bear mind: pkgdown best autolink references help topics articles described vignette(\"linking\"). pkgdown executes examples, inserting rendered results generated HTML files. default, pkgdown generates reference index just alphabetically-ordered list functions. index much useful human curation functions can grouped described categories. override default, provide reference field _pkgdown.yml. entry reference can take one three forms: title, defined title optional desc (description) fields. subtitle, defined subtitle optional desc (description) fields. list topics defined contents field. Note use starts_with() select functions common prefix. can also use ends_with() matches(). See complete details ?build_reference. iterating reference index might want run pkgdown::build_reference_index(). just re-builds index page, making faster quickly change _pkgdown.yml see affects site.","code":"reference: - title: \"Connecting to Spark\"   desc: >     Functions for installing Spark components and managing     connections to Spark   contents:    - spark_config   - spark_connect   - spark_disconnect   - spark_install   - spark_log - title: \"Reading and Writing Data\"   desc: \"Functions for reading and writing Spark DataFrames.\"   contents:   - starts_with(\"spark_read\")   - starts_with(\"spark_write\")   - matches(\"saveload\")"},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"articles","dir":"Articles","previous_headings":"","what":"Articles","title":"Introduction to pkgdown","text":"pkgdown automatically build vignettes found vignettes/, translating HTML files articles/. Due way pkgdown integrate RMarkdown generated HTML HTML, relatively little control available output format. can see details ?build_articles. want include article website package (e.g., ’s large), can either place subdirectory vignettes/ (e.g. vignettes/web_only) add .Rbuildignore (make sure ’s vignettes: section yaml header). extreme case want produce articles vignettes, add complete vignettes/ directory .Rbuildignore ensure DESCRIPTION VignetteBuilder field.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"news","dir":"Articles","previous_headings":"","what":"News","title":"Introduction to pkgdown","text":"NEWS.md present, rendered single-page changelog based markdown level headings. pkgdown assumes NEWS.md formatted using level one headings (#) specify package name version number, level two headings (##) provide topical organization release. See suggestions writing news bullets tidyverse style guide. See ?build_news customisation options including : Create one page major version related minor versions. Add release announcements news navbar drop-.","code":"# pkgdown 1.1.0  ## Bug Fixes  * Lots of them  # pkgdown 1.0.0  * This is the first release of pkgdown."},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"publishing","dir":"Articles","previous_headings":"","what":"Publishing","title":"Introduction to pkgdown","text":"use GitHub, two ways publish site GitHub Pages: Build site locally, check docs directory, configure GitHub Pages use directory. Use GitHub actions automatically build publish site every time make change. easiest way set run usethis::use_pkgdown_github_pages().","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/pkgdown.html","id":"promoting","dir":"Articles","previous_headings":"","what":"Promoting","title":"Introduction to pkgdown","text":"finalized site built published web, publicize URL places: URL field package DESCRIPTION, alongside link source: (usethis::use_pkgdown_github_pages() .) repository description GitHub. (usethis::use_pkgdown_github_pages() .) Twitter (make sure include #rstats).","code":"URL: https://pkgdown.r-lib.org, https://github.com/r-lib/pkgdown"},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"bootstrap-5-built-in-search","dir":"Articles","previous_headings":"","what":"Bootstrap 5: built-in search","title":"Search","text":"BS5, search built-building pkgdown website automatically build search index ’s available navbar (using fuse.js). Currently available customisation excluding paths search index: Note search requires “real” server, local file:// based preview, search won’t work default preview. test search local preview, ’ll need use servr::httw(\"docs\") similar.","code":"search:   exclude: ['news/index.html']"},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"bootstrap-3-algolia","dir":"Articles","previous_headings":"","what":"Bootstrap 3: Algolia","title":"Search","text":"pkgdown websites can integrate search capability using DocSearch Algolia. DocSearch powerful search engine free documentation websites. two steps needed enable DocSearch pkgdown website.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"indexing","dir":"Articles","previous_headings":"Bootstrap 3: Algolia","what":"Indexing","title":"Search","text":"published pkgdown website, submit pkgdown site URL Docsearch. Docsearch contact via e-mail confirm website owner. Docsearch set crawler configuration indexes site every 24 hours. pkgdown builds suggested Docsearch crawler configuration docsearch.json point Docsearch team configuration starting point. want optimize search, Docsearch accept pull requests configuration incorporate additional options fine tune scraping.","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/search.html","id":"configuration","dir":"Articles","previous_headings":"Bootstrap 3: Algolia","what":"Configuration","title":"Search","text":"Docsearch team e-mail JavaScript integrate website. Put value apiKey indexName parameters site _pkgdown.yml template: params: also need add url: field _pkgdown.yml specifies location documentation web. pkgdown, URL field : building custom Docsearch index, can also include Docsearch app_id _pkgdown.yml. See pkgdown configuration functional search configuration. configuration complete, find search bar re-building site. search enabled, pressing shift + / (.e., “?”) move focus search bar.","code":"<script type=\"text/javascript\">   docsearch({      apiKey: 'API_KEY',  // a long hex string     indexName: 'INDEX_NAME',      inputSelector: '### REPLACE ME ####',      debug: false // Set debug to true if you want to inspect the dropdown  }); template:   params:     docsearch:       api_key: API_KEY       index_name: INDEX_NAME url: https://pkgdown.r-lib.org"},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"footnotes","dir":"Articles > Test","previous_headings":"","what":"Footnotes","title":"Output Rendering","text":"Yay1","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"figures","dir":"Articles > Test","previous_headings":"","what":"Figures","title":"Output Rendering","text":"","code":"plot(1:10)"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"external-files","dir":"Articles > Test","previous_headings":"","what":"External files","title":"Output Rendering","text":"","code":"x <- readLines(\"test.txt\") x #> [1] \"a\" \"b\" \"c\" \"d\""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"details-tag","dir":"Articles > Test","previous_headings":"","what":"Details tag","title":"Output Rendering","text":"First paragraph","code":"1 + 2 #> [1] 3"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"mathjax","dir":"Articles > Test","previous_headings":"","what":"Mathjax","title":"Output Rendering","text":"\\[f(x) = \\dfrac{1}{\\sqrt{2\\pi\\sigma^2}} e^{-\\frac{(x-\\mu^2)}{2\\sigma^2}}\\] Inline equations: \\(y=x^2\\)","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"line-width","dir":"Articles > Test","previous_headings":"Code","what":"Line width","title":"Output Rendering","text":"","code":"pkgdown:::ruler() #> ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 #> 12345678901234567890123456789012345678901234567890123456789012345678901234567890  cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"should-be-highlighted","dir":"Articles > Test","previous_headings":"Code","what":"Should be highlighted","title":"Output Rendering","text":"Valid R code \\preformatted{}: R code R block: R code r block: Yaml","code":"mean(a + 1) mean(a + 1) mean(a + 1) yaml: [a, 1]"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"shouldnt-be-highlighted","dir":"Articles > Test","previous_headings":"Code","what":"Shouldn’t be highlighted","title":"Output Rendering","text":"Non-R code \\preformatted{}","code":"yaml: [a, b, c]"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"crayon","dir":"Articles > Test","previous_headings":"Code","what":"Crayon","title":"Output Rendering","text":"text text","code":"cat(cli::col_red(\"This is red\"), \"\\n\") #> This is red cat(cli::col_blue(\"This is blue\\n\"), \"\\n\") #> This is blue #>   message(cli::col_green(\"This is green\")) #> This is green  warning(cli::style_bold(\"This is bold\")) #> Warning: This is bold stop(cli::style_italic(\"This is italic\")) #> Error in eval(expr, envir, enclos): This is italic"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"quoted-text","dir":"Articles > Test","previous_headings":"","what":"Quoted text","title":"Output Rendering","text":"Single-line quote something miscellaneous. Flush  1 space indent   2 space indent    3 space indent","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"this-section-is-unnumbered","dir":"Articles > Test","previous_headings":"","what":"This section is unnumbered","title":"Output Rendering","text":"however bug !","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"tabset-with-pills","dir":"Articles > Test","previous_headings":"Tabsets","what":"Tabset with pills","title":"Output Rendering","text":"Tab 1 Tab 2 blablablabla “cool” heading blop","code":"1 + 1"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"cool","dir":"Articles > Test","previous_headings":"Tabsets > Tabset with pills","what":"cool","title":"Output Rendering","text":"Stuff","code":""},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"tabset-without-pills","dir":"Articles > Test","previous_headings":"Tabsets","what":"Tabset without pills","title":"Output Rendering","text":"Tab 1 Tab 2 something nice  tab active","code":"plot(1:42)"},{"path":"https://pkgdown.r-lib.org/dev/articles/test/rendering.html","id":"fading-tabset","dir":"Articles > Test","previous_headings":"Tabsets","what":"Fading tabset","title":"Output Rendering","text":"English French German Hello! Bonjour! Guten tag.","code":""},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/articles/test/widgets.html","id":"widgets","dir":"Articles > Test","previous_headings":"","what":"Widgets","title":"HTML widgets","text":"Test spacing widget. Test spacing widget.","code":""},{"path":"https://pkgdown.r-lib.org/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Hadley Wickham. Author, maintainer. Jay Hesselberth. Author. Maëlle Salmon. Author. . Copyright holder, funder.","code":""},{"path":"https://pkgdown.r-lib.org/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Wickham H, Hesselberth J, Salmon M (2024). pkgdown: Make Static HTML Documentation Package. R package version 2.0.8.9000, https://github.com/r-lib/pkgdown, https://pkgdown.r-lib.org.","code":"@Manual{,   title = {pkgdown: Make Static HTML Documentation for a Package},   author = {Hadley Wickham and Jay Hesselberth and Maëlle Salmon},   year = {2024},   note = {R package version 2.0.8.9000, https://github.com/r-lib/pkgdown},   url = {https://pkgdown.r-lib.org}, }"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"pkgdown-","dir":"","previous_headings":"","what":"Build websites for R packages","title":"Build websites for R packages","text":"pkgdown designed make quick easy build website package. can see pkgdown action https://pkgdown.r-lib.org: output pkgdown applied latest version pkgdown. Learn vignette(\"pkgdown\") ?build_site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Build websites for R packages","text":"","code":"# Install development version from GitHub # install.packages(\"pak\") pak::pak(\"r-lib/pkgdown\")"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Build websites for R packages","text":"Get started usethis: use pkgdown build website: generates docs/ directory containing website. README.md becomes homepage, documentation man/ generates function reference, vignettes rendered articles/. Read vignette(\"pkgdown\") details, learn deploy site GitHub pages.","code":"# Run once to configure your package to use pkgdown usethis::use_pkgdown() pkgdown::build_site()"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"pkgdown-200-and-bootstrap-5","dir":"","previous_headings":"Usage","what":"pkgdown 2.0.0 and Bootstrap 5","title":"Build websites for R packages","text":"pkgdown 2.0.0 includes upgrade Bootstrap 3 Bootstrap 5, accompanied whole bunch minor UI improvements. ’ve heavily customised site, ’s small chance break site, everyone needs explicitly opt-upgrade adding following _pkgdown.yml: learn many new ways customise site vignette(\"customise\").","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"in-the-wild","dir":"","previous_headings":"","what":"In the wild","title":"Build websites for R packages","text":"last count, pkgdown used 11,000 packages. examples created contributors pkgdown: bayesplot (source): plotting functions posterior analysis, model checking, MCMC diagnostics. valr (source): read manipulate genome intervals signals. mkin (source): calculation routines based FOCUS Kinetics Report NMF (source): framework perform non-negative matrix factorization (NMF). Comparing source output sites great way learn new pkgdown techniques.","code":""},{"path":"https://pkgdown.r-lib.org/dev/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of conduct","title":"Build websites for R packages","text":"Please note project released Contributor Code Conduct. participating project agree abide terms.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate pkgdown data structure — as_pkgdown","title":"Generate pkgdown data structure — as_pkgdown","text":"generally need use unless need custom site design writing equivalent build_site().","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate pkgdown data structure — as_pkgdown","text":"","code":"as_pkgdown(pkg = \".\", override = list())"},{"path":"https://pkgdown.r-lib.org/dev/reference/as_pkgdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate pkgdown data structure — as_pkgdown","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatically link references and articles in an HTML page — autolink_html","title":"Automatically link references and articles in an HTML page — autolink_html","text":"Deprecated: please use downlit::downlit_html_path instead.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatically link references and articles in an HTML page — autolink_html","text":"","code":"autolink_html(input, output = input, local_packages = character())"},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatically link references and articles in an HTML page — autolink_html","text":"input, output Input output paths HTML file local_packages named character vector providing relative paths (value) packages (name) can reached relative links target HTML document.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/autolink_html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatically link references and articles in an HTML page — autolink_html","text":"","code":"if (FALSE) { autolink_html(\"path/to/file.html\",   local_packages = c(     shiny = \"shiny\",     shinydashboard = \"shinydashboard\"   ) ) }"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":null,"dir":"Reference","previous_headings":"","what":"Build articles section — build_articles","title":"Build articles section — build_articles","text":"build_articles() renders R Markdown file underneath vignettes/ saves articles/. two exceptions: Files start _ (e.g., _index.Rmd) ignored, enabling use child documents. Files vignettes/tutorials handled build_tutorials() Vignettes rendered using special document format reconciles rmarkdown::html_document() pkgdown template. means articles behave slightly differently vignettes, particularly respect external files, custom output formats. See details. Note run build_articles() directly (outside build_site()) vignettes use currently installed version package, current source version. makes iteration quicker primarily working text article.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build articles section — build_articles","text":"","code":"build_articles(   pkg = \".\",   quiet = TRUE,   lazy = TRUE,   seed = 1014L,   override = list(),   preview = NA )  build_article(   name,   pkg = \".\",   data = list(),   lazy = FALSE,   seed = 1014L,   new_process = TRUE,   quiet = TRUE )  build_articles_index(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build articles section — build_articles","text":"pkg Path package. quiet Set FALSE display output knitr pandoc. useful debugging. lazy TRUE, re-build article input file modified recently output file. seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. name Name article render. either path relative vignettes/ without extension, index README. data Additional data pass template. new_process Build article clean R process? default, TRUE, ensures every article build fresh environment, may want set FALSE make debugging easier.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"index-and-navbar","dir":"Reference","previous_headings":"","what":"Index and navbar","title":"Build articles section — build_articles","text":"can control articles index navbar articles field _pkgdown.yml. use , pkgdown check articles included, error missed . articles field defines list sections, can contain four fields: title (required): title section, appears heading articles index. desc (optional): optional markdown description displayed underneath section title. navbar (optional): couple words used label section navbar. omitted, section vignettes appear navbar. contents (required): list article names include section. can either names individual vignettes call starts_with(). name vignette includes path vignettes without extension name vignette found vignettes/pizza/slice.Rmd pizza/slice. title description individual vignettes displayed index comes title description fields YAML header Rmds. example, yaml might used version dplyr:   Note use navbar fields. navbar: ~ means \"Main verbs\" appear navbar without heading; absence navbar field developer vignettes means accessible via articles index. navbar include link articles index one vignettes available navbar. vignettes appear navbar drop-list others , list automatically include \"...\" link bottom; vignettes appear navbar, link directly articles index instead providing drop-.","code":"articles: - title: Main verbs   navbar: ~   contents:   - one-table   - two-table   - rowwise   - colwise  - title: Developer   desc: Vignettes aimed at package developers   contents:   - programming   - packages"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"get-started","dir":"Reference","previous_headings":"","what":"Get started","title":"Build articles section — build_articles","text":"Note vignette name package (e.g., vignettes/pkgdown.Rmd vignettes/articles/pkgdown.Rmd) automatically becomes top-level \"Get started\" link, appear articles drop-. (package name includes ., e.g. pack., use - vignette name, e.g. pack-.Rmd.)","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"external-files","dir":"Reference","previous_headings":"","what":"External files","title":"Build articles section — build_articles","text":"pkgdown differs base R handling external files. building vignettes, R assumes vignettes self-contained (reasonable assumption vignettes PDFs) copies files explicitly listed .install_extras. pkgdown takes different approach based rmarkdown::find_external_resources(), also copy images link . reason automatic detection work, need add resource_files field yaml metadata, e.g.:   Note can use fig.path change output directory generated figures default value strong assumption rmarkdown.","code":"--- title: My Document resource_files:   - data/mydata.csv   - images/figure.png ---"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"embedding-shiny-apps","dir":"Reference","previous_headings":"","what":"Embedding Shiny apps","title":"Build articles section — build_articles","text":"like embed Shiny app article, app hosted independently, (e.g. https://www.shinyapps.io). , can embed app article using <iframe>, e.g. <iframe src = \"https://gallery.shinyapps.io/083-front-page\" class=\"shiny-app\">. See https://github.com/r-lib/pkgdown/issues/838#issuecomment-430473856 hints customise appearance CSS.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"output-formats","dir":"Reference","previous_headings":"","what":"Output formats","title":"Build articles section — build_articles","text":"default, pkgdown builds articles using rmarkdown::html_document() output format, ignoring whatever set YAML metadata. necessary pkgdown integrate HTML/CSS/JS vignette HTML/CSS/JS rest site. challenges combining two sources HTML/CSS/JS, limited support output formats opt-setting as_is field .Rmd metadata:   output format produces PDF, also need specify extension field:   work pkgdown, output format must accept template, theme, self_contained arguments, must work without additional CSS JSS files. Note use _output.yml _site.yml still need add as_is: true individual vignette. Additionally, htmlwidgets work as_is: true.","code":"pkgdown:   as_is: true pkgdown:   as_is: true   extension: pdf"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"suppressing-vignettes","dir":"Reference","previous_headings":"","what":"Suppressing vignettes","title":"Build articles section — build_articles","text":"want articles vignettes, either put subdirectories list .Rbuildignore. articles link automatically added default navbar vignettes directory present: want , need customise navbar. See build_site() details.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_articles.html","id":"figures","dir":"Reference","previous_headings":"","what":"Figures","title":"Build articles section — build_articles","text":"can control default rendering figures specifying figures field _pkgdown.yml. default settings equivalent :   parameters interpreted similarly knitr chunk options. .parameters list parameters available custom graphics output devices HTML widgets.","code":"figures:   dev: ragg::agg_png   dpi: 96   dev.args: []   fig.ext: png   fig.width: 7.2916667   fig.height: ~   fig.retina: 2   fig.asp: 1.618   bg: NA   other.parameters: []"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":null,"dir":"Reference","previous_headings":"","what":"Create favicons from package logo — build_favicons","title":"Create favicons from package logo — build_favicons","text":"function auto-detects location package logo (name logo.svg (recommended format) logo.png) runs https://realfavicongenerator.net API build complete set favicons different sizes, needed modern web usage.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create favicons from package logo — build_favicons","text":"","code":"build_favicons(pkg = \".\", overwrite = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create favicons from package logo — build_favicons","text":"pkg Path package. overwrite TRUE, re-create favicons package logo.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_favicons.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create favicons from package logo — build_favicons","text":"need run function . favicon set stored pkgdown/favicon copied init_site() relevant location website rebuilt. complete, add pkgdown/ .Rbuildignore  avoid NOTE package checking.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":null,"dir":"Reference","previous_headings":"","what":"Build home section — build_home_index","title":"Build home section — build_home_index","text":"build_home() function generates pages top-level site including: home page HTML files .md files ./ .github/. authors page (DESCRIPTION) citation page (inst/CITATION, present). license page default 404 page .github/404.md found. build_home_index() rebuilds just index page; useful rapidly iterating experimenting site styles.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build home section — build_home_index","text":"","code":"build_home_index(pkg = \".\", quiet = TRUE)  build_home(pkg = \".\", override = list(), preview = NA, quiet = TRUE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build home section — build_home_index","text":"pkg Path package. quiet Set FALSE display output knitr pandoc. useful debugging. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"home-page","dir":"Reference","previous_headings":"","what":"Home page","title":"Build home section — build_home_index","text":"main content home page (index.html) generated pkgdown/index.md, index.md, README.md, order. packages use README.md also displayed GitHub CRAN. Use index.md want package website look different README, use pkgdown/index.md want file live package root directory. use index.Rmd README.Rmd responsibility knit document create corresponding .md. pkgdown touches files doc/ directory. Extra markdown files base directory (e.g. ROADMAP.md) .github/ (e.g. CODE_OF_CONDUCT.md) copied build_home() docs/ converted HTML. home page also features sidebar information extracted package. can tweak via configuration file, help make home page informative possible landing page.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"images-and-figures","dir":"Reference","previous_headings":"","what":"Images and figures","title":"Build home section — build_home_index","text":"want include images README.md, must stored somewhere package can displayed CRAN website. best place put man/figures. generating figures R Markdown, make sure set fig.path followed:   usually go chunk include = FALSE.","code":"knitr::opts_chunk$set(   fig.path = \"man/figures/\" ) ```{r chunk-name, include=FALSE} knitr::opts_chunk$set(   fig.path = \"man/figures/\" ) ```"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"package-logo","dir":"Reference","previous_headings":"","what":"Package logo","title":"Build home section — build_home_index","text":"package logo, can include top README level-one heading:   init_site() also automatically create favicon set package logo.","code":"# pkgdown <img src=\"man/figures/logo.png\" align=\"right\" />"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"yaml-config-home","dir":"Reference","previous_headings":"","what":"YAML config - home","title":"Build home section — build_home_index","text":"tweak home page, need section configuration file called home.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"page-title-and-description","dir":"Reference","previous_headings":"","what":"Page title and description","title":"Build home section — build_home_index","text":"default, page title description extracted automatically Title Description fields DESCRIPTION (stripping single quotes quoted words). CRAN ensures fields contain phrases like \"R package\" obvious CRAN. make package findable search engines, good practice override title description, thinking people might search :   (Note use YAML's > .e. \"YAML pipes\"; convenient way writing paragraphs text.)","code":"home:   title: An R package for pool-noodle discovery   description: >     Do you love R? Do you love pool-noodles? If so, you might enjoy     using this package to automatically discover and add pool-noodles     to your growing collection."},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"readme-header","dir":"Reference","previous_headings":"","what":"README header","title":"Build home section — build_home_index","text":"READMEs usually start <h1> containing package name. feels duplicative package name navbar can remove strip_header: true:","code":"home:   strip_header: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"dev-badges","dir":"Reference","previous_headings":"","what":"Dev badges","title":"Build home section — build_home_index","text":"pkgdown identifies badges three ways: image-containing links <!-- badges: start --> <!-- badges: end -->, e.g. created usethis::use_readme_md() usethis::use_readme_rmd(). always empty line <!-- badges: end --> line. divide badges paragraphs, make sure add empty line <!-- badges: end --> line. image-containing links within <div id=\"badges\"><\/div>. Within first paragraph, contains image-containing links. Identified badges removed main content. shown sidebar depending development mode sidebar customization, see sidebar section.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"authors","dir":"Reference","previous_headings":"","what":"Authors","title":"Build home section — build_home_index","text":"default, pkgdown display author information three places: sidebar, left part side footer, author page. documentation describes customise overall author display. See ?build_home ?build_site details changing location authors information within home sidebar site footer.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"authors-orcid-and-bio","dir":"Reference","previous_headings":"","what":"Authors ORCID and bio","title":"Build home section — build_home_index","text":"Author ORCID identification numbers DESCRIPTION linked using ORCID logo:   want add details authors involvement package, can use comment field, rendered authors page.","code":"Authors@R: c(     person(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = c(\"aut\", \"cre\"),       comment = c(ORCID = \"0000-0003-4757-117X\")     ),     person(\"Jay\", \"Hesselberth\", role = \"aut\",       comment = c(ORCID = \"0000-0002-6299-179X\")     )   ) Authors@R: c(     person(\"Hadley\", \"Wickham\", , \"hadley@rstudio.com\", role = c(\"aut\", \"cre\"),       comment = c(ORCID = \"0000-0003-4757-117X\", \"Indenter-in-chief\")     ),     person(\"Jay\", \"Hesselberth\", role = \"aut\",       comment = c(ORCID = \"0000-0002-6299-179X\")     )   )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"yaml-config-authors","dir":"Reference","previous_headings":"","what":"YAML config - authors","title":"Build home section — build_home_index","text":"can tweak things via authors YAML field: display author footer, sidebar authors page, authors (role) displayed sidebar footer, text authors footer, text authors sidebar, text authors authors page. can modify author's name displayed adding subsection authors. entry authors named author's name (matching DESCRIPTION) can contain href /html fields: href provided, author's name linked URL. html provided, shown instead author's name. particularly useful want display logo corporate sponsor. Use absolute URL image, relative link. Use empty alternative text rather alternative text screen-reader skip .   default, \"developers\" list shown sidebar footer populated maintainer (\"cre\"), authors (\"aut\"), funder (\"fnd\") DESCRIPTION. choose roles filtering. configuration : maintainer funder(s) appear footer, text \"Crafted \", authors contributors appear sidebar, authors list sidebar preceded followed text, authors list authors page preceded followed text.   want filter authors based something else roles, consider using custom sidebar/footer component (see ?build_home/?build_site, respectively).","code":"authors:   firstname lastname:     href: \"http://name-website.com\"     html: \"<img src='https://website.com/name-picture.png' width=72 alt=''>\" authors:   footer:     roles: [cre, fnd]     text: \"Crafted by\"   sidebar:     roles: [aut, ctb]     before: \"So *who* does the work?\"     after: \"Thanks all!\"   before: \"This package is proudly brought to you by:\"   after: \"See the [changelog](news/index.html) for other contributors. :pray:\""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_home.html","id":"sidebar","dir":"Reference","previous_headings":"","what":"Sidebar","title":"Build home section — build_home_index","text":"can customise homepage sidebar home.sidebar field. made two pieces: structure, defines overall layout, components, defines piece looks like. organisation makes easy mix match pkgdown defaults customisations. default structure:   drawn seven built-components: links: automated links generated URL BugReports fields DESCRIPTION plus manual links home.links field:   license: Licensing information LICENSE/LICENCE LICENSE.md/LICENCE.md files present. community: links .github/CONTRIBUTING.md, .github/CODE_OF_CONDUCT.md, etc. citation: link package citation information. Uses either inst/CITATION , absent, information DESCRIPTION. authors: selected authors DESCRIPTION. dev: development status badges extracted README.md/index.md. shown \"development\" versions websites; see \"Development mode\" ?build_site details. toc: table contents README (shown default). can also add components, text markdown text:   Alternatively, can provide ready-made sidebar HTML:   completely remove :","code":"home:   sidebar:     structure: [links, license, community, citation, authors, dev] home:   links:   - text: Link text     href: https://website.com   - text: Roadmap     href: /roadmap.html home:   sidebar:     structure: [authors, custom, toc, dev]     components:       custom:         title: Funding         text: We are *grateful* for funding! home:   sidebar:     html: path-to-sidebar.html home:   sidebar: FALSE"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":null,"dir":"Reference","previous_headings":"","what":"Build news section — build_news","title":"Build news section — build_news","text":"NEWS.md broken versions using level one (#) level two headings (##) (partially) match one following forms (ignoring case): {package name} 1.3.0 {package name} v1.3.0 Version 1.3.0 Changes 1.3.0 Changes v1.3.0","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build news section — build_news","text":"","code":"build_news(pkg = \".\", override = list(), preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build news section — build_news","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Build news section — build_news","text":"common structure news files use top level heading release, use second level heading break individual bullets sections.   Issues contributors automatically linked corresponding pages GitHub GitHub repo can discovered DESCRIPTION (typically URL entry containing github.com) version available CRAN, release date automatically added heading (see suppress); available CRAN, \"Unreleased\" added.","code":"# foofy 1.0.0  ## Major changes  * Can now work with all grooveable grobbles!  ## Minor improvements and bug fixes  * Printing scrobbles no longer errors (@githubusername, #100)  * Wibbles are now 55% less jibbly (#200)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_news.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build news section — build_news","text":"automatically link release announcements, include releases section.   Control whether news present one page multiple pages one_page field. default true.   Suppress default addition CRAN release dates :","code":"news:  releases:  - text: \"usethis 1.3.0\"    href: https://www.tidyverse.org/articles/2018/02/usethis-1-3-0/  - text: \"usethis 1.0.0 (and 1.1.0)\"    href: https://www.tidyverse.org/articles/2017/11/usethis-1.0.0/ news:   one_page: false news:   cran_dates: false"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":null,"dir":"Reference","previous_headings":"","what":"Build reference section — build_reference","title":"Build reference section — build_reference","text":"default, pkgdown generate index lists functions alphabetical order. override , provide reference section _pkgdown.yml described .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build reference section — build_reference","text":"","code":"build_reference(   pkg = \".\",   lazy = TRUE,   examples = TRUE,   run_dont_run = FALSE,   seed = 1014L,   override = list(),   preview = NA,   devel = TRUE,   document = \"DEPRECATED\",   topics = NULL )  build_reference_index(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build reference section — build_reference","text":"pkg Path package. lazy TRUE, rebuild pages .Rd recent .html. makes much easier rapidly prototype. set FALSE build_site(). examples Run examples? run_dont_run Run examples surrounded \\dontrun? seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. devel Determines code loaded order run examples. TRUE (default), assumes live development environment, loads source package pkgload::load_all(). FALSE, uses installed version package. document Deprecated Use devel instead. topics Build specified topics. supplied, sets lazy preview FALSE.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"reference-index","dir":"Reference","previous_headings":"","what":"Reference index","title":"Build reference section — build_reference","text":"tweak index page, add section called reference _pkgdown.yml. can contain three different types element: title (title + desc), generates row containing <h2> optional paragraph description. subtitle (subtitle + desc), generates row containing <h3> optional paragraph description. list topics (contents), generates one row topic, list aliases topic left, topic title right. (historical reasons can include contents title subtitle, longer recommended). packages need use title contents components. example, snippet YAML pkgdown uses generate reference index:   Bigger packages, e.g. ggplot2, may need additional layer structure order clearly organise large number functions:   desc can use markdown, long description good idea take advantage YAML > notation:","code":"reference: - title: Build   desc:  Build a complete site or its individual section components. - contents:   - starts_with(\"build_\") - title: Templates - contents:   - template_navbar   - render_page reference: - title: Layers - subtitle: Geoms   desc: Geom is short for geometric element - contents:   - starts_with(\"geom\") - subtitle: Stats   desc: Statistical transformations transform data before display.   contents:   - starts_with(\"stat\") desc: >   This is a very _long_ and **overly** flowery description of a   single simple function. By using `>`, it's easy to write a description   that runs over multiple lines."},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"topic-matching","dir":"Reference","previous_headings":"","what":"Topic matching","title":"Build reference section — build_reference","text":"contents can contain: Individual function/topic names. Weirdly named functions doubled quoting, YAML R, e.g. \"`+.gg`\". starts_with(\"prefix\") select functions common prefix. ends_with(\"suffix\") select functions common suffix. matches(\"regexp\") complex regular expressions. has_keyword(\"x\") select topics keyword \"x\"; has_keyword(\"datasets\") selects data documentation. has_concept(\"blah\") select topics concept \"blah\". using roxygen2, has_concept() also matches family tags, roxygen2 converts concept tags. lacks_concepts(c(\"concept1\", \"concept2\")) select topics without concepts. useful capture topics otherwise captured has_concepts(). Topics installed packages, e.g. rlang::is_installed() (function name) sass::font_face (topic name). functions (except has_keywords()) automatically exclude internal topics (.e. \\keyword{internal}). can choose include (e.g.) starts_with(\"build_\", internal = TRUE). Use leading - remove topics section, e.g. -topic_name, -starts_with(\"foo\"). pkgdown check non-internal topics included reference index page, error missed .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"missing-topics","dir":"Reference","previous_headings":"","what":"Missing topics","title":"Build reference section — build_reference","text":"pkgdown warn (non-internal) topics listed reference index. can suppress warnings listing topics section \"title: internal\" (case sensitive) displayed reference index.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"icons","dir":"Reference","previous_headings":"","what":"Icons","title":"Build reference section — build_reference","text":"can optionally supply icon help topic. , need top-level icons directory. contain .png files either 30x30 (regular display) 60x60 (want retina display). Icons matched topics aliases.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build reference section — build_reference","text":"need run extra code examples run, can create pkgdown/pre-reference.R pkgdown/post-reference.R.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_reference.html","id":"figures","dir":"Reference","previous_headings":"","what":"Figures","title":"Build reference section — build_reference","text":"can control default rendering figures specifying figures field _pkgdown.yml. default settings equivalent :   parameters interpreted similarly knitr chunk options. .parameters list parameters available custom graphics output devices HTML widgets.","code":"figures:   dev: ragg::agg_png   dpi: 96   dev.args: []   fig.ext: png   fig.width: 7.2916667   fig.height: ~   fig.retina: 2   fig.asp: 1.618   bg: NA   other.parameters: []"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":null,"dir":"Reference","previous_headings":"","what":"Build search index — build_search","title":"Build search index — build_search","text":"Build JSON file encompassing HTML pages, use search script.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build search index — build_search","text":"","code":"build_search(pkg = \".\", override = list())"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build search index — build_search","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build search index — build_search","text":"can exclude paths search index. exclude changelog search index.","code":"search:   exclude: ['news/index.html']"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_search.html","id":"debugging-and-local-testing","dir":"Reference","previous_headings":"","what":"Debugging and local testing","title":"Build search index — build_search","text":"Locally (opposed GitHub Pages Netlify instance), search work simply use pkgdown preview static files. can use servr::httw(\"docs\") instead. search working, run pkgdown::pkgdown_sitrep() eliminate common issues absence URL pkgdown configuration file package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a complete pkgdown website — build_site","title":"Build a complete pkgdown website — build_site","text":"build_site() convenient wrapper around six functions: init_site() build_home() build_reference() build_articles() build_tutorials() build_news() See documentation function learn control aspect site. page documents options affect whole site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a complete pkgdown website — build_site","text":"","code":"build_site(   pkg = \".\",   examples = TRUE,   run_dont_run = FALSE,   seed = 1014L,   lazy = FALSE,   override = list(),   preview = NA,   devel = FALSE,   new_process = !devel,   install = !devel,   document = \"DEPRECATED\" )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a complete pkgdown website — build_site","text":"pkg Path package. examples Run examples? run_dont_run Run examples surrounded \\dontrun? seed Seed used initialize random number generation order make article output reproducible. integer scalar NULL seed. lazy TRUE, rebuild articles reference pages source newer destination. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser. devel Use development deployment process? TRUE, uses lighter-weight process suitable rapid iteration; run examples vignettes current process, load code pkgload::load_all(). FALSE, first install package temporary library, run examples vignettes new process. build_site() defaults devel = FALSE get high fidelity outputs building complete site; build_reference(), build_home() friends default devel = TRUE can rapidly iterate development. new_process TRUE, run build_site() separate process. enhances reproducibility ensuring nothing loaded current process affects build process. install TRUE, install package temporary library available vignettes. document Deprecated Use devel instead.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"general-config","dir":"Reference","previous_headings":"","what":"General config","title":"Build a complete pkgdown website — build_site","text":"destination controls site generated, defaulting docs/. Paths relative package root. url optional, strongly recommended.   specifies site published used allow pkgdown sites link site needed (vignette(\"linking\")), generate sitemap.xml, automatically generate CNAME deploying github, generate metadata needed rich social \"media cards\" (vignette(\"metadata\")), . title overrides default site title, package name. used page title default navbar.","code":"url: https://pkgdown.r-lib.org"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"development-mode","dir":"Reference","previous_headings":"","what":"Development mode","title":"Build a complete pkgdown website — build_site","text":"development field allows generate different sites development released versions package. use , first need set development mode:","code":"development:   mode: auto"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"setting-development-mode","dir":"Reference","previous_headings":"","what":"Setting development mode","title":"Build a complete pkgdown website — build_site","text":"development mode site controls site built, colour package version navbar, version tooltip, whether site indexed search engines. four possible modes: automatic (mode: auto): automatically determines mode based version number: 0.0.0.9000 (0.0.0.*): unreleased. four version components: development. everything else -> release. release (mode: release), default. Site written docs/. Version navbar gets default colouring. Development badges shown sidebar (see ?build_home). development (mode: devel). Site written docs/dev/. navbar version gets \"danger\" class tooltip stating docs -development version package. noindex meta tag used ensure packages indexed search engines. Development badges shown sidebar (see ?build_home). unreleased (mode: unreleased). Site written docs/. Version navbar gets \"danger\" class, message indicating package yet CRAN. Development badges shown sidebar (see ?build_home). can override mode specified _pkgdown.yml setting setting PKGDOWN_DEV_MODE devel release.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"selective-html","dir":"Reference","previous_headings":"","what":"Selective HTML","title":"Build a complete pkgdown website — build_site","text":"can selectively show HTML devel release site adding class pkgdown-devel pkgdown-release. easily accessed .Rmd files can use pandoc's <div> syntax control block markdown display. example, can use following markdown README show GitHub install instructions development version site:   can use similar technique control badges displayed. markdown show CRAN status badge site released package GitHub check status development package:","code":"::: {.pkgdown-devel} You can install the development version of pkgdown from GitHub with: `remotes::install_github(\"r-lib/pkgdown\")` ::: [![CRAN Status](https://www.r-pkg.org/badges/version/pkgdown)]   (https://cran.r-project.org/package=pkgdown){.pkgdown-release} [![R-CMD-check](https://github.com/r-lib/pkgdown/workflows/R-CMD-check/badge.svg)]   (https://github.com/r-lib/pkgdown/actions){.pkgdown-devel}"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"other-options","dir":"Reference","previous_headings":"","what":"Other options","title":"Build a complete pkgdown website — build_site","text":"three options can control:   destination allows override default subdirectory used development site; defaults dev/. version_label allows override style used development (unreleased) versions package. defaults \"danger\", can set \"default\", \"info\", \"warning\" instead. (precise colours determined bootstrap theme, become progressively eye catching go default danger). Finally, can choose override default tooltip version_tooltip.","code":"development:   destination: dev   version_label: danger   version_tooltip: \"Custom message here\""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"page-layout","dir":"Reference","previous_headings":"","what":"Page layout","title":"Build a complete pkgdown website — build_site","text":"navbar, footer, sidebar fields control appearance navbar, footer, sidebar respectively. many individual options documented Layout section vignette(\"customise\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"search","dir":"Reference","previous_headings":"","what":"Search","title":"Build a complete pkgdown website — build_site","text":"search field controls built-search documented vignette(\"search\").","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"template","dir":"Reference","previous_headings":"","what":"Template","title":"Build a complete pkgdown website — build_site","text":"template field mostly used control appearance site. See vignette(\"customise\") details. two template fields control aspects site: noindex: true suppress indexing pages search engines:   google_site_verification allows verify site google:   trailing_slash_redirect: true automatically redirect -package-url.com -package-url.com/, using JS script added <head> home page. useful certain redirect scenarios.","code":"template:   params:     noindex: true template:   params:     google_site_verification: _nn6ile-a6x6lctOW template:   trailing_slash_redirect: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"analytics","dir":"Reference","previous_headings":"","what":"Analytics","title":"Build a complete pkgdown website — build_site","text":"capture usage site web analytics platform, can make use includes field add HTML supplied platform. Typically either placed after_body in_header. include examples , highly recommend getting recommended HTML directly platform. GoatCounter:   Google analytics:   plausible.io:","code":"template:   includes:     after_body: >       <script data-goatcounter=\"https://{YOUR CODE}.goatcounter.com/count\" data-goatcounter-settings=\"{YOUR SETTINGS}\" async src=\"https://gc.zgo.at/count.js\"><\/script> template:   includes:     in_header: |        <!-- Global site tag (gtag.js) - Google Analytics -->        <script async src=\"https://www.googletagmanager.com/gtag/js?id={YOUR TRACKING ID}\"#' ><\/script>        <script>          window.dataLayer = window.dataLayer || [];          function gtag(){dataLayer.push(arguments);}          gtag('js', new Date());           gtag('config', '{YOUR TRACKING ID}');        <\/script> templates:   includes:     in_header: |       <script defer data-domain=\"{YOUR DOMAIN}\" src=\"https://plausible.io/js/plausible.js\"><\/script>"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"source-repository","dir":"Reference","previous_headings":"","what":"Source repository","title":"Build a complete pkgdown website — build_site","text":"Use repo field override pkgdown's automatically discovery source repository. used navbar, homepage, articles reference topics, changelog (link issue numbers user names). pkgdown can automatically figure necessary URLs link GitHub GitLab repo BugReports URL field. Otherwise, can supply repo field:   home: path package home source code repository. source:: path source individual file default branch. issue: path individual issue. user: path user. varying components (e.g. path, issue number, user name) pasted end URLs trailing /s. pkgdown can automatically link Jira issues well specify custom issue URL well Jira project names auto-link jira_projects. can specify many projects like:   pkgdown defaults using \"HEAD\" branch source file URLs. can configured use specific branch linking source files specifying branch name:","code":"repo:   url:     home: https://github.com/r-lib/pkgdown/     source: https://github.com/r-lib/pkgdown/blob/HEAD/     issue: https://github.com/r-lib/pkgdown/issues/     user: https://github.com/ repo:   jira_projects: [this_project, another_project]   url:     issue: https://jira.organisation.com/jira/browse/ repo:   branch: devel"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"deployment-deploy-","dir":"Reference","previous_headings":"","what":"Deployment (deploy)","title":"Build a complete pkgdown website — build_site","text":"single deploy field install_metadata allows install package index metadata package . Normally metadata made available published site; installing package means available autolinking even website reachable build time (e.g. behind firewall requires auth).","code":"deploy:   install_metadata: true"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"redirects","dir":"Reference","previous_headings":"","what":"Redirects","title":"Build a complete pkgdown website — build_site","text":"change structure documentation (renaming vignettes help topics) can setup redirects old content new content. One several now-absent pages can redirected new page (new section new page). works creating html page performs \"meta refresh\", best way redirect works everywhere might deploy site. syntax following, old paths left, new paths URLs right.   reason choose redirect existing page make sure exclude search index, see ?build_search.","code":"redirects:   - [\"articles/old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/another-old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/yet-another-old-vignette-name.html\", \"https://pkgdown.r-lib.org/dev\"]"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"options","dir":"Reference","previous_headings":"","what":"Options","title":"Build a complete pkgdown website — build_site","text":"Users limited internet connectivity can disable CRAN checks setting options(pkgdown.internet = FALSE). also disable features pkgdown requires internet connectivity. However, used build docs package requires internet connectivity examples vignettes, connection required option apply . Users can set timeout build_site(new_process = TRUE) options(pkgdown.timeout = Inf), useful prevent stalled builds hanging cron jobs.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Build a complete pkgdown website — build_site","text":"","code":"if (FALSE) { build_site()  build_site(override = list(destination = tempdir())) }"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":null,"dir":"Reference","previous_headings":"","what":"Build site for GitHub pages — build_site_github_pages","title":"Build site for GitHub pages — build_site_github_pages","text":"Designed run part automated workflows deploying GitHub pages. cleans old site, builds site dest_dir adds .nojekyll file suppress rendering Jekyll, adds CNAME file needed. designed run CI, default : Cleans old site. install package. Runs build_site() process.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build site for GitHub pages — build_site_github_pages","text":"","code":"build_site_github_pages(   pkg = \".\",   ...,   dest_dir = \"docs\",   clean = TRUE,   install = FALSE,   new_process = FALSE )"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_site_github_pages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build site for GitHub pages — build_site_github_pages","text":"pkg Path package. ... Additional arguments passed build_site(). dest_dir Directory build site . clean Clean files old site. install TRUE, install package temporary library available vignettes. new_process TRUE, run build_site() separate process. enhances reproducibility ensuring nothing loaded current process affects build process.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":null,"dir":"Reference","previous_headings":"","what":"Build tutorials section — build_tutorials","title":"Build tutorials section — build_tutorials","text":"learnr tutorials must hosted elsewhere require R execution engine. Currently, pkgdown build publish tutorials , makes easy embed (using <iframe>s) published tutorials. Tutorials automatically discovered published tutorials inst/tutorials vignettes/tutorials. Alternatively, can list _pkgdown.yml described .","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build tutorials section — build_tutorials","text":"","code":"build_tutorials(pkg = \".\", override = list(), preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build tutorials section — build_tutorials","text":"pkg Path package. override optional named list used temporarily override values _pkgdown.yml preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/build_tutorials.html","id":"yaml-config","dir":"Reference","previous_headings":"","what":"YAML config","title":"Build tutorials section — build_tutorials","text":"override default discovery process, can provide tutorials section. list element specifies: name: used generated file name title: used page heading navbar url: embedded iframe source: optional, present linked ","code":"tutorials: - name: 00-setup   title: Setting up R   url: https://jjallaire.shinyapps.io/learnr-tutorial-00-setup/ - name: 01-data-basics   title: Data basics   url: https://jjallaire.shinyapps.io/learnr-tutorial-01-data-basics/"},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Check _pkgdown.yml — check_pkgdown","title":"Check _pkgdown.yml — check_pkgdown","text":"Check _pkgdown.yml valid without building whole site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check _pkgdown.yml — check_pkgdown","text":"","code":"check_pkgdown(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/check_pkgdown.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check _pkgdown.yml — check_pkgdown","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Clean site — clean_site","title":"Clean site — clean_site","text":"Delete files docs/ (except CNAME).","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Clean site — clean_site","text":"","code":"clean_site(pkg = \".\", quiet = FALSE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/clean_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Clean site — clean_site","text":"pkg Path package. quiet TRUE, suppresses message.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"deploy_site_github() designed deploy site Travis CI, longer recommend, function deprecated. two replacements: usethis::use_pkgdown_github_pages() setup GitHub action automatically build deploy package website GitHub pages. deploy_to_branch() can called locally build deploy website desired branch.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"","code":"deploy_site_github(   pkg = \".\",   install = TRUE,   tarball = Sys.getenv(\"PKG_TARBALL\", \"\"),   ssh_id = Sys.getenv(\"id_rsa\", \"\"),   commit_message = construct_commit_message(pkg),   clean = FALSE,   verbose = FALSE,   host = \"github.com\",   ...,   repo_slug = Sys.getenv(\"TRAVIS_REPO_SLUG\", \"\") )"},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_site_github.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a pkgdown site on Travis-CI to Github Pages — deploy_site_github","text":"pkg Path package. install Optionally, opt-automatic installation. necessary package documenting dependency pkgdown tarball location built package tarball. default Travis configuration R packages sets PKG_TARBALL path. ssh_id private id use, base64 encoded content private pem file. personal private key. Instead create new keypair specifically deploying site. easiest way use travis::use_travis_deploy(). commit_message commit message used commit. clean Clean files old site. verbose Print verbose output host GitHub host url. ... Additional arguments passed build_site(). repo_slug user/repo slug repository.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":null,"dir":"Reference","previous_headings":"","what":"Build and deploy a site locally — deploy_to_branch","title":"Build and deploy a site locally — deploy_to_branch","text":"Assumes git clone project, package already installed. Use usethis::use_pkgdown_github_pages() automate process using GitHub actions.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build and deploy a site locally — deploy_to_branch","text":"","code":"deploy_to_branch(   pkg = \".\",   commit_message = construct_commit_message(pkg),   clean = TRUE,   branch = \"gh-pages\",   remote = \"origin\",   github_pages = (branch == \"gh-pages\"),   ...,   subdir = NULL )"},{"path":"https://pkgdown.r-lib.org/dev/reference/deploy_to_branch.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build and deploy a site locally — deploy_to_branch","text":"pkg Path package. commit_message commit message used commit. clean Clean files old site. branch git branch deploy remote git remote deploy github_pages GitHub pages deploy. TRUE, adds CNAME file custom domain name support, .nojekyll file suppress jekyll rendering. ... Additional arguments passed build_site(). subdir sub-directory site built branch. argument can used support number site configurations. example, build version-specific documentation setting subdir = \"v1.2.3\"; deploy_to_branch() build deploy package documentation v.1.2.3/ directory site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":null,"dir":"Reference","previous_headings":"","what":"Get current settings for figures — fig_settings","title":"Get current settings for figures — fig_settings","text":"generally need use function unless handling custom plot output. Packages needing custom parameters ask users place within .parameters entry package name, e.g.","code":"figures:   other.parameters:     rgl:       fig.asp: 1"},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get current settings for figures — fig_settings","text":"","code":"fig_settings()"},{"path":"https://pkgdown.r-lib.org/dev/reference/fig_settings.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get current settings for figures — fig_settings","text":"list containing entries figures field _pkgdown.yml (see build_reference()), default values added. Computed width height values (pixels) also included.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Determine if code is executed by pkgdown — in_pkgdown","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"occasionally useful need different behaviour pkgdown regular documentation.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"","code":"in_pkgdown()"},{"path":"https://pkgdown.r-lib.org/dev/reference/in_pkgdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Determine if code is executed by pkgdown — in_pkgdown","text":"","code":"in_pkgdown() #> [1] TRUE"},{"path":"https://pkgdown.r-lib.org/dev/reference/index-topic.html","id":null,"dir":"Reference","previous_headings":"","what":"Index — index","title":"Index — index","text":"Index","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Initialise site infrastructure — init_site","title":"Initialise site infrastructure — init_site","text":"init_site(): creates output directory (docs/), generates machine readable description site, used autolinking, copies CSS/JS assets extra files, runs build_favicons(), needed. See vignette(\"customise\") various ways can customise display site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Initialise site infrastructure — init_site","text":"","code":"init_site(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Initialise site infrastructure — init_site","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/init_site.html","id":"build-ignored-files","dir":"Reference","previous_headings":"","what":"Build-ignored files","title":"Initialise site infrastructure — init_site","text":"recommend using usethis::use_pkgdown() build-ignore docs/ _pkgdown.yml. use another directory, create site manually, need add .Rbuildignore . NOTE unexpected file R CMD CHECK indication correctly ignored files.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown-package.html","id":null,"dir":"Reference","previous_headings":"","what":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","title":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","text":"Generate attractive useful website source package. 'pkgdown' converts documentation, vignettes, 'README', 'HTML' making easy share information package online.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"pkgdown: Make Static HTML Documentation for a Package — pkgdown-package","text":"Maintainer: Hadley Wickham hadley@posit.co (ORCID) Authors: Jay Hesselberth (ORCID) Maëlle Salmon (ORCID) contributors: Posit Software, PBC [copyright holder, funder]","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":null,"dir":"Reference","previous_headings":"","what":"Print object in pkgdown output — pkgdown_print","title":"Print object in pkgdown output — pkgdown_print","text":"lets package authors control objects printed just pkgdown examples. default call print() apart htmlwidgets object returned (sizes tweaked).","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print object in pkgdown output — pkgdown_print","text":"","code":"pkgdown_print(x, visible = TRUE)"},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print object in pkgdown output — pkgdown_print","text":"x Object display visible Whether visible ","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_print.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print object in pkgdown output — pkgdown_print","text":"Either character vector representing printed output (escaped HTML necessary) literal HTML produced htmltools htmlwidgets packages.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":null,"dir":"Reference","previous_headings":"","what":"Report package pkgdown situation — pkgdown_sitrep","title":"Report package pkgdown situation — pkgdown_sitrep","text":"pkgdown_sitrep() reports url field pkgdown configuration; pkgdown website URL stored DESCRIPTION file.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Report package pkgdown situation — pkgdown_sitrep","text":"","code":"pkgdown_sitrep(pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/pkgdown_sitrep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Report package pkgdown situation — pkgdown_sitrep","text":"pkg Path package.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Preview a local pkgdown page in the browser — preview_page","title":"Preview a local pkgdown page in the browser — preview_page","text":"works rendering working directory, common interactive workflow.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Preview a local pkgdown page in the browser — preview_page","text":"","code":"preview_page(path, pkg = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":null,"dir":"Reference","previous_headings":"","what":"Open site in browser — preview_site","title":"Open site in browser — preview_site","text":"Open site browser","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Open site in browser — preview_site","text":"","code":"preview_site(pkg = \".\", path = \".\", preview = NA)"},{"path":"https://pkgdown.r-lib.org/dev/reference/preview_site.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Open site in browser — preview_site","text":"pkg Path package. path Path relative destination preview TRUE, .na(preview) && interactive(), preview freshly generated section browser.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":null,"dir":"Reference","previous_headings":"","what":"Translate an Rd string to its HTML output — rd2html","title":"Translate an Rd string to its HTML output — rd2html","text":"Translate Rd string HTML output","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Translate an Rd string to its HTML output — rd2html","text":"","code":"rd2html(x, fragment = TRUE, ...)"},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Translate an Rd string to its HTML output — rd2html","text":"x Rd string. Backslashes must double-escaped (\"\\\\\"). fragment logical indicating whether represents complete Rd file ... additional arguments as_html","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/rd2html.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Translate an Rd string to its HTML output — rd2html","text":"","code":"rd2html(\"a\\n%b\\nc\") #> [1] \"a\"           \"<!-- %b -->\" \"c\"            rd2html(\"a & b\") #> [1] \"a &amp; b\"  rd2html(\"\\\\strong{\\\\emph{x}}\") #> [1] \"<strong><em>x<\/em><\/strong>\""},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":null,"dir":"Reference","previous_headings":"","what":"Render page with template — render_page","title":"Render page with template — render_page","text":"page composed four templates: \"head\", \"header\", \"content\", \"footer\". templates rendered using data, assembled overall page using \"layout\" template.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render page with template — render_page","text":"","code":"render_page(pkg = \".\", name, data, path, depth = NULL, quiet = FALSE)  data_template(pkg = \".\", depth = 0L)"},{"path":"https://pkgdown.r-lib.org/dev/reference/render_page.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render page with template — render_page","text":"pkg Path package document. name Name template (e.g. \"home\", \"vignette\", \"news\") data Data template. automatically supplemented three lists: site: title path root. yaml: template key _pkgdown.yml. package: package metadata including name andversion. See full contents running data_template(). path Location create file; relative destination directory. depth Depth path relative base directory. quiet quiet, suppress output messages","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate YAML templates — template_navbar","title":"Generate YAML templates — template_navbar","text":"Use function generate default YAML pkgdown uses different parts _pkgdown.yml. useful starting points want customise site.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate YAML templates — template_navbar","text":"","code":"template_navbar(path = \".\")  template_reference(path = \".\")  template_articles(path = \".\")"},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate YAML templates — template_navbar","text":"path Path package root","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/templates.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate YAML templates — template_navbar","text":"","code":"if (FALSE) { pkgdown::template_navbar() }  if (FALSE) { pkgdown::template_reference() }  if (FALSE) { pkgdown::template_articles() }"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-crayon.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: crayon — test-crayon","title":"Test case: crayon — test-crayon","text":"Test case: crayon","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-crayon.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: crayon — test-crayon","text":"","code":"cat(cli::col_red(\"This is red\"), \"\\n\") #> This is red  cat(cli::col_blue(\"This is blue\"), \"\\n\") #> This is blue   message(cli::col_green(\"This is green\")) #> This is green  warning(cli::style_bold(\"This is bold\")) #> Warning: This is bold"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-dont.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: don't — test-dont","title":"Test case: don't — test-dont","text":"Test case: ","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-dont.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: don't — test-dont","text":"","code":"if (FALSE) {   abort(\"This is an error!\") }  # Inline \\donttest is silently ommitted message(\"Hi!\") #> Hi!  # Block \\donttest indicated with comments # \\donttest{ # This is a comment 1 + 3 #> [1] 4 # }  # And works even when not at the top level if (TRUE) {   # \\donttest{   1 + 2   # } } #> [1] 3  answer <- 1 # \\dontshow{ answer <- 42 # } answer # should be 42 #> [1] 42  # To hide the \\dontshow part, for conditional examples if (FALSE) { answer <- 43 } answer # should be still 42 #> [1] 42  # But this one runs, and the condition is hidden answer <- 43 answer #> [1] 43"},{"path":[]},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-figures.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: figures — test-figures","text":"","code":"x <- seq(0, 2 * pi, length.out = 25) plot(x, sin(x))   plot(1:10) lines(1:10) text(2, 5, \"Hello\", srt = 30, cex = 2)"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-links.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: links — test-links","title":"Test case: links — test-links","text":"","code":"magrittr::subtract(10, 1) #> [1] 9"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-links.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: links — test-links","text":"","code":"magrittr::subtract(10, 1) #> [1] 9  library(magrittr, warn.conflicts = FALSE) subtract(10, 1) #> [1] 9"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"bulleted-list","dir":"Reference","previous_headings":"","what":"Bulleted list","title":"Test case: lists — test-lists","text":"item... spans multiple paragraphs.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"numbered-list","dir":"Reference","previous_headings":"","what":"Numbered list","title":"Test case: lists — test-lists","text":"b","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-lists.html","id":"definition-list","dir":"Reference","previous_headings":"","what":"Definition list","title":"Test case: lists — test-lists","text":"short short short Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad   minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip   ex ea commodo consequat. Duis aute irure dolor reprehenderit   voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur   sint occaecat cupidatat non proident, sunt culpa qui officia deserunt   mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. short Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed   eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum   adipiscing elit, sed  eiusmod tempor incididunt ut labore et dolore ad   minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip   ex ea commodo consequat. Duis aute irure dolor reprehenderit   voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur   sint occaecat cupidatat non proident, sunt culpa qui officia deserunt   mollit anim id est laborum.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-long-lines.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: long-lines — test-long-lines","title":"Test case: long-lines — test-long-lines","text":"example results copy button correctly placed scrollings","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-long-lines.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: long-lines — test-long-lines","text":"","code":"pkgdown:::ruler() #> ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 #> 12345678901234567890123456789012345678901234567890123456789012345678901234567890  cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x  cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy cat(rep(\"x \", 100), sep = \"\") #> x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x  cat(rep(\"xy\", 100), sep = \"\") #> xyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxy"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-output-styles.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: output styles — test-output-styles","title":"Test case: output styles — test-output-styles","text":"Test case: output styles","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-output-styles.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Test case: output styles — test-output-styles","text":"","code":"# This example illustrates some important output types # The following output should be wrapped over multiple lines a <- 1:100 a #>   [1]   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18 #>  [19]  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36 #>  [37]  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54 #>  [55]  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72 #>  [73]  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90 #>  [91]  91  92  93  94  95  96  97  98  99 100  cat(\"This some text!\\n\") #> This some text! message(\"This is a message!\") #> This is a message! warning(\"This is a warning!\") #> Warning: This is a warning!  # This is a multi-line block {   1 + 2   2 + 2 } #> [1] 4"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-params.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: params — test-params","title":"Test case: params — test-params","text":"Test case: params","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Test case: params — test-params","text":"... ellipsis","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-sexpr-title.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: sexpr — test-sexpr-title","title":"Test case: sexpr — test-sexpr-title","text":"Test case: sexpr","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":null,"dir":"Reference","previous_headings":"","what":"Test case: preformatted blocks & syntax highlighting — test-verbatim","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Manual test cases various ways embedding code sections. code blocks copy paste button.","code":""},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":"should-be-highlighted","dir":"Reference","previous_headings":"","what":"Should be highlighted","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Valid R code \\preformatted{}:   R code R block:   R code r block:   Yaml","code":"mean(a + 1) mean(a + 1) mean(a + 1) yaml: [a, 1]"},{"path":"https://pkgdown.r-lib.org/dev/reference/test-verbatim.html","id":"shouldn-t-be-highlighted","dir":"Reference","previous_headings":"","what":"Shouldn't be highlighted","title":"Test case: preformatted blocks & syntax highlighting — test-verbatim","text":"Non-R code \\preformatted{}","code":"yaml: [a, b, c]"},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-development-version","dir":"Changelog","previous_headings":"","what":"pkgdown (development version)","title":"pkgdown (development version)","text":"build_reference_index() gives informative errors contents field malformed (#2323). left right footers longer contain extra empty paragraph tag footer gains additional padding-top keep whitespace constant (#2381). build_article_index() build_reference_index() use improved BS5 template correctly wraps section description <div>, rather <p>. eliminates empty pargraph tag preceded section description (#2352). build_news() now warns doesn’t find version headings, suggesting NEWS.md structured incorrectly (#2213). build_article() gains new new_process argument allows build vignette current process debugging purposes. ’ve also improved error messages tracebacks article fails build, hopefully also making debugging easier (#2438). Preview links now work (#2435). build_home() longer renders Github issue pull request templates (@hsloot, #2362) now easier preview parts website locally interactively. build_reference_index() friends call init_site() internally instead erroring (@olivroy, #2329). Fixed issue introduced 2.0.8 pkgdown using Bootstrap version specified template package (@gadenbuie, #2443). check_pkgdown() longer errors intro vignette article listed _pkgdown.yml (@olivroy #2150).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-208","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.8","title":"pkgdown 2.0.8","text":"CRAN release: 2024-04-10 pkgdown now compatible (requires) bslib >= 0.5.1 (@gadenbuie, #2395), including fix BS5 navbar template get navbar.type: dark work Bootstrap 5.3+ (@tanho63, #2388) Now uses cli provide interactive feedback. Avoid unwanted linebreaks parsing DESCRIPTION (@salim-b, #2247). Translations New Catalan translation (@jmaspons, #2333). Citation sections correctly translated (@eliocamp, #2410). build_article_index() now sorts vignettes non-vignette articles alphabetically filename (literally, basename()), default (@jennybc, #2253). Deprecated build_favicon() removed (build_favicons() remains). build_articles() now sets RNG seed default. Use build_articles(seed = NULL) old (unreproducible) behaviour. (@salim-b, #2354). build_articles() process .qmd articles quarto vignette builder (@rcannood, #2404). build_articles() build_reference() now set RNG seed htmlwidgets IDs. reduces noise final HTML output, articles examples contain htmlwidgets (@salim-b, #2294, #2354). build_news() correctly parses github profiles issues links present beginning list items (@pearsonca, #2122) build_reference() sets seed correctly; previously reset early (@salim-b, #2355) Rd -> html translation \\cr now translated <br> <br /> (#2400). Correct usage S3 methods non-syntactic class names (#2384). Preserve Markdown code blocks class rmd roxygen2 docs (@salim-b, #2298). build_reference_index() longer generates redundant entries multiple explicit @usage tags provided (@klmr, #2302) build_reference_index() correctly handles topic names conflict selector functions (@dmurdoch, #2397).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-207","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.7","title":"pkgdown 2.0.7","text":"CRAN release: 2022-12-14 Fix topic match selection unmatched selection followed matched selection (@bundfussr, #2234) Fix highlighting nested R code blocks (instance, example R Markdown code chunks) (@idavydov, #2237). Tweak German translation (@krlmlr, @mgirlich, @lhdjung, #2149, #2236) Remove mention (defunct) Twitter card validator, provide alternatives (@Bisaloo, #2185) Fix keywords typo check_missing_topics() message (@swsoyee, #2178). Use jsdeliver CDN bootstrap-toc (@GregorDeCillia, #2207).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-206","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.6","title":"pkgdown 2.0.6","text":"CRAN release: 2022-07-16 ’re using RStudio daily, output file names now clickable, previewing generated HTML browser (#2157). Getting started vignette longer needs included articles index (#2150). aren’t functions \\usage{} block, pkgdown now shows aliases reference index, rather just topic name (#1624).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-205","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.5","title":"pkgdown 2.0.5","text":"CRAN release: 2022-06-23 Correctly generate downlit link targets topics file name ending . (#2128). build_articles(): build fails index doesn’t include articles, ’re now told articles missing (@zkamvar, #2121). build_home() now escapes angle brackets author comments(#2127). build_home() automatically render link .github/SUPPORT.md (@IndrajeetPatil, #2124). build_news() fails link @username start bullet. reverted #2030 #2122. build_reference(): restore accidentally nerfed has_keyword() has_concept() reference selectors (#2126) add tests.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-204","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.4","title":"pkgdown 2.0.4","text":"CRAN release: 2022-06-10 New check_pkgdown() provides lightweight way check _pkgdown.yml valid without building site (#2056). Invalid _pkgdown.yml now consistently generates errors locally CI (#2055). build_article() now supports inline markdown title (#2039). build_home() longer shows development status badges released version site (#2054). build_news() support automated @username links places (#2030). build_reference(): can exclude topics reference index - (#2040). Inline markdown titles subtitles now supported(#2039). Package logos automatically stripped .Rd don’t end two one page. (#2083). \\figure{file}{alternative text} multiline alt text now parsed correctly (#2080) roxygen 7.2.0 output generic code blocks (#2092, @jabenninghoff) processed correctly. Front end changes: Automatically added links code blocks now styled less aggressively, occupy less visual weight page (#2007). article pages given class col-md-9 consistency pages (#2045). Fixed width HTML widgets sized correctly (@dmurdoch, #2062). Footnotes work contents, including code (@banfai, #2042). Navbar components now accept target argument (#2089, @JSchoenbachler). New syntax highlighting themes a11y-light, a11y-dark, monochrome-light, monochrome-dark, solarized","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-203","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.3","title":"pkgdown 2.0.3","text":"CRAN release: 2022-04-24 Fixes R CMD check","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-202","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.2","title":"pkgdown 2.0.2","text":"CRAN release: 2022-01-13 New Korean (ko) translation thanks @mrchypark @peremen (#1944). New Danish (dk) translation thanks @LDalby. build_articles() now adjusts heading levels vignettes/articles use <h1> section headings ensure ’s one top-level heading (#2004). ensures ’s one <h1>, title, page, makes TOC sidebar work correctly. build_home_index() longer spuriously complains missing images use plots README.Rmd (#1980, #1977). longer tweaks src path <img> tags absolute paths (#1955). build_news() works NEWS.md uses <h1> headings (#1947). build_reference() now correctly interprets title: internal: removes section reference index doesn’t list topics section missing (#1958). build_reference() now gives correct hint reference index YAML formatted correctly (e.g. empty item, item “n” needs escaped quotes interpreted Boolean) (#1995). deploy_to_branch() gains subdir argument, allowing deploy site subdirectory (@gadenbuie, #2001). Front end changes: navbar gets little space version number, aligns baseline rest navbar (#1989). Long lines code output scroll, rather wrapped. different ’ll see console, ’s better fit web pages available code width varies based browser width (#1940). scrollspy (highlights “active” heading sidebar) now computes offset dynamically makes work better sites taller navbars (#1993). Fixed js issues occurred pages without table contents (@gadenbuie, #1998). htmlwidgets jQuery Bootstrap dependencies used examples articles, pkgdown’s versions jQuery Boostrap take precedence versions used htmlwidget (@gadenbuie, #1997). pkgdown longer includes bundled author metadata Hadley Wickham, RStudio, RConsortium, since now ways include meta data template packages, special casing three entities feels increasingly weird (#1952).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-201","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.1","title":"pkgdown 2.0.1","text":"CRAN release: 2021-12-03 Fix CRAN failures. Reference sections de-duplicated correctly (#1935). Usage sections generated topics ; usage correctly displayed BS3 (#1931) Empty \\value{} longer errors (#1930).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-200","dir":"Changelog","previous_headings":"","what":"pkgdown 2.0.0","title":"pkgdown 2.0.0","text":"CRAN release: 2021-11-30","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-authors-2-0-0","dir":"Changelog","previous_headings":"","what":"New authors","title":"pkgdown 2.0.0","text":"@maelle now pkgdown author recognition significant sustained contributions. powerhouse behind many improvements release, particularly switch bootstrap 5, improvements customisation, implementation local search.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"bootstrap-2-0-0","dir":"Changelog","previous_headings":"","what":"Bootstrap 5","title":"pkgdown 2.0.0","text":"pkgdown can style site Bootstrap 5 (help @jayhesselberth, @apreshill, @cpsievert). Opt-setting boostrap version _pkgdown.yml: reviewed site accessibility made number small improvements: (#782, #1553): Default font larger links always underlined. Heading anchors use aria-hidden reduce noise screenreader users. Navbar dropdowns improved aria-labelledby. default GitHub/GitLab links gain aria-label; use icons now supported, encouraged docs. Syntax highlighting uses new accessible colour scheme, designed Alison Hill (#1536) skip link makes easier get directly page contents (#1827). -line footnotes mean can read asides next text refer . Articles support tabsets, R Markdown. (@JamesHWade, #1667). minor styling improvements: active item TOC indicated background colour, rather border. present, package logo shown pages near header. Section anchors now appear right (making usable mobile phones) (#1782). TOC scrollable independently main content. makes useful long pages many headings (#1610). sidebar shown bottom page narrow screens. Function arguments reference index (#1822) use definition lists (<dl>) instead tables. gives room long argument names/lists function detailed descriptions, displays better mobile. Links homepage longer show full url text. default navbar longer includes home icon - took precious horizontal space wasn’t useful since already link home page immediately left (#1383).","code":"template:   bootstrap: 5"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"local-search-2-0-0","dir":"Changelog","previous_headings":"","what":"Local search","title":"pkgdown 2.0.0","text":"pkgdown now supports local searching (.e. searching without external service), enabled default Bootstrap 5 sites since set-needed (#1629, help @gustavdelius #1655 @dieghernan & @GregorDeCillia #1770). pkgdown builds exhaustive sitemap.xml even websites built Bootstrap 3. might change Algolia results use Algolia search (#1629).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"customisation-2-0-0","dir":"Changelog","previous_headings":"","what":"Customisation","title":"pkgdown 2.0.0","text":"New vignette(\"customise\") documents ways can customise site, including new options described (#1573). Sites can easily themed either bootswatch themes selectively overriding bslib variables used generate CSS. pkgdown now uses scss Bootstrap css tweaks, means can customise site within _pkgdown.yml. can pick variety built-syntax highlighting themes (#1823). control colours (background) code <pre> tags. pkgdown can now translate text generates (#1446): means package docs written another language, can match pkgdown UI provide seamless experience non-English speakers. Activate translations setting lang _pkgdown.yml: pkgdown includes translations : es, Spanish, thanks @edgararuiz-zz, @dieghernan, @rivaquiroga. de, German, thanks @hfrick. fr, French, thanks @romainfrancois, @lionel-, @jplecavalier, @maelle. pt, Portuguese, thanks @rich-iannone. tr, Turkish, thanks @mine-cetinkaya-rundel. zh_CN, simplified Chinese, thanks @yitao. ’re interested adding translations language please file issue ’ll help get started. Template packages can now provide inst/pkgdown/_pkgdown.yml used set defaults _pkgdown.yml. can used (e.g.) provide author definitions, select Bootstrap version define bslib variables, customise sidebar, footer, navbar, etc. (#1499). New includes parameters -header, -body, -body make easy add arbitrary HTML every page. content placed end <head> tag, right opening <body> tag, closing tag <\/body> respectively (#1487). match bookdown options in_header, before_body after_body. Additionally, can use before_title, before_navbar, after_navbar add arbitrary HTML navbar/page header; appear left package name/version, left right navigation links respectively (#1882). Authors configuration flexible (#1516). can now: Choose roles used filtering authors sidebar footer. Choose text authors footer. Add text authors list sidebar. Add text authors list authors page. Sidebar specification flexible (#1443, #1488, #1502). can now: Change order sidebar elements. Add custom sidebar sections (Markdown/HTML text). Add table contents home page. Completely suppress sidebar. Provide HTML navbar. Footer specification flexible (#1502). can now: Change placement elements left right. Add text left right (even remove/replace default text) can now exclude default components navbar (#1517). Expert users can now override layout templates provided pkgdown template packages placing template files pkgdown/templates (@gadenbuie, #1897).","code":"lang: fr"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-2-0-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 2.0.0","text":"pkgdown now supports redirects (#1259, @lorenzwalthert). following yaml demonstrates syntax, old paths left new paths/URLs right. Use HTML classes pkgdown-devel pkgdown-release declare certain content appear devel release site. Use class pkgdown-hide content appear GitHub/CRAN (#1299). New pkgdown_sitrep() function reports whether site set correctly; particularly currently reports auto-linking work (#1478).","code":"redirects:   - [\"articles/old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/another-old-vignette-name.html\", \"articles/new-vignette-name.html\"]   - [\"articles/yet-another-old-vignette-name.html\", \"https://pkgdown.r-lib.org/dev\"]"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"code-2-0-0","dir":"Changelog","previous_headings":"","what":"Code","title":"pkgdown 2.0.0","text":"Styling errors, warnings, messages tweaked. Messages now displayed way output, warnings errors bolded, coloured. part suite changes aim give package authors greater control appearance messages, warnings, errors. Long lines code output now wrapped, rather requiring scrolling. better matches rmarkdown::html_document() see console. build_reference() now allows linking topics packages (either function names e.g. rlang::is_installed topic names e.g.  sass::font_face). (#1664) build_reference() now runs examples options(rlang_interactive = FALSE) (ensuring non-interactive behaviour functions use rlang::is_interactive()), options(cli.dynamic = FALSE), Sys.setenv(RSTUDIO = NA) Sys.setLocale(\"LC_COLLATE\", \"C\") (#1693). also runs pkgdown/pre-reference.R pkgdown/post-reference.R examples. allow setup teardown operations might need (#1602). reference index section title: internal now silently dropped, allowing suppress warnings topics listed index (#1716). Code blocks now highlighted according declared language (e.g. yaml) documentation built roxygen2 7.1.2 later (#1690, #1692). New pkgdown_print() allows control objects rendered examples. includes built-handling htmlwidgets “browseable” HTML pkgdown output now closely resembles see RStudio. Added extension points make HTML widgets (RGL particular) work rendered examples (@dmurdoch). can globally set width code output (reference articles) Articles now render output styles created cli/crayon (#1556). copy pasting code blocks, lines containing output (e.g. #>) automatically omitted (#1675). Auto-linking improvements: Links inherited R6 methods now work correctly internal (#1173, @vandenman) external (#1476) parent classes. Linking longer fails package contains duplicated Rd aliases. Correctly link reference pages \\name{} entry doesn’t match file name (@dmurdoch, #1586; #1676).","code":"code:   width: 50"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-2-0-0","dir":"Changelog","previous_headings":"","what":"Articles","title":"pkgdown 2.0.0","text":"Article subtitle, author date (specified YAML frontmatter) now correctly omitted article table contents sidebar (@maxheld83, #1428). Support as_is: true non-default output formats vignettes/ articles somewhat improved. Support fundamentally limited due challenges integrating HTML output formats pkgdown doesn’t know , little reliable little better documented (#1757, #1764). build_articles() longer fails directory underneath vignettes .Rmd extension (#1425). build_articles() now correctly handles links images man/figures (form ../man/figures) (#1472). build_articles() sets theme argument document format NULL as_is: true lets users override via theme argument output format. build_articles() build_home() now warn images won’t render website ’re unsupported directories (#1810). Generally, ’s safe refer figures man/figures vignettes. Articles stored vignettes/articles moved one level appear articles/ website. Previously, appear articles/articles, build_redirects() automatically adds redirects articles vignettes/articles directory (@gadenbuie #1911).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"html-css-and-js-2-0-0","dir":"Changelog","previous_headings":"","what":"HTML, CSS and JS","title":"pkgdown 2.0.0","text":"New template option trailing_slash_redirect allows adding script redirect -package-url.com -package-url.com/ (#1439, @cderv, @apreshill). External links now get class external-link. makes easier style CSS (#881, #1491). Duplicated section ids now de-duplicated; makes pkgdown work better documentation R6 classes. Updated CSS styles pandoc improve styling reference lists (#1469).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"deployment-2-0-0","dir":"Changelog","previous_headings":"","what":"Deployment","title":"pkgdown 2.0.0","text":"build_site_github_pages() extracted deploy_site_github() make easier decouple building deployment, can take advantage standard deployment actions (#1756). deploy_to_branch() now calls git remote set-branches --add avoid overwriting existing remote.{remote}.fetch value (@kyleam, #1382). also now cleans website directory default; revert previous behaviour clean = FALSE (#1394). build_reference() error envar CI true missing topics (@ThierryO, #1378). can override auto development mode detected package version setting env var PKGDOWN_DEV_MODE release devel. useful package uses different convention indicate development release versions (#1081).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-minor-improvements-and-bug-fixes-2-0-0","dir":"Changelog","previous_headings":"","what":"Other minor improvements and bug fixes","title":"pkgdown 2.0.0","text":"\\special{} tags complex contents rendered correctly (@klmr, #1744). \\arguments{} \\value{} better job handling mingled items text (#1479). contents \\value{} now shown immediately \\arguments{}. default “branch” linking file sources HEAD, work regardless whether default branch called “main” “master”. Non-ORCID comments Authors@R now usable: comments exist, sidebar gains link authors page, displayed (#1516). Citations without text versions better handled, text citations correctly escaped HTML (@bastistician, #1507). README badges single paragraph placed <!-- badges: end --><!-- badges: end --> comments detected (#1603). 404 page (default .github/404.md) longer built development mode (see ?build_site) e.g. GitHub pages uses 404.html site root (#1622). links 404 pages (navbar, scripts, CSS) now absolute URL configuration file (#1622). version tooltip showed top navbar now set ’ve explicitly set development.mode _pkgdown.yml (#1768). heading (e.g. headings reference index page, arguments heading reference pages) now get anchors (#1747). Use autolink_bare_uris Pandoc version 2.0 (@marcosmolla, #1618). pkgdown now recognizes GitLab URLs source repository adds corresponding icon navbar (#1493). also supports GitLab subgroups (@salim-b, #1532). Links GitHub Enterprise GitLab Enterprise repositories detected assuming host address begin github. gitlab. (@ijlyttle, #1452). rules drawn CLI (example, build_site()) protected narrow terminal windows (@maxheld83, #1435). Google Site Verification (https://support.google.com/webmasters/answer/9008080?hl=en) can now configured pkgdown sites. build_rmarkdown_format sets html_document(anchor_sections = FALSE) avoid needless dependencies (@atusy, #1426). Jira issues NEWS can automatically linked setting project name repo: jira_projects: [...] specifying custom issue URL repo: url: issue: ... _pkgdown.yml (@jonkeane, #1466). build_home() always creates citation information authors page, using metadata DESCRIPTION inst/CITATION file, links sidebar (#1904). build_news() longer breaks URLs containing numeric fragments (@krassowski, #1456), recognises styles release heading (#1437), generate stable IDs using combination heading slug package number. (@Bisaloo, #1015)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-161","dir":"Changelog","previous_headings":"","what":"pkgdown 1.6.1","title":"pkgdown 1.6.1","text":"CRAN release: 2020-09-12 article index (used autolinking vignettes across packages) works (#1401).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-160","dir":"Changelog","previous_headings":"","what":"pkgdown 1.6.0","title":"pkgdown 1.6.0","text":"CRAN release: 2020-09-07","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"major-changes-1-6-0","dir":"Changelog","previous_headings":"","what":"Major changes","title":"pkgdown 1.6.0","text":"pkgdown now uses new downlit package syntax highlighting autolinking (reference topics vignettes). little change behaviour code downlit extracted pkgdown, makes easier use pkgdown’s nice linking/highlighting places (#1234). pkgdown now uses ragg::agg_png() device generate example figures. little faster produce higher quality output. Learn https://ragg.r-lib.org (#1320).","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"rd-translation-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Rd translation","title":"pkgdown 1.6.0","text":"\\special{} support inside \\usage{} added allow non-standard R usage syntax (@klmr, #1345). #ifdef #ifndef now supported; “current” OS hard coded “unix” ensure reproducible output regardless build website (#1384). Nested \\subsection{}s now generate appropriate heading levels (h3, h4, h5 etc) (#1377), get anchor links (#1389). \\preformatted{} longer double escapes contents (#1311).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-and-vignettes-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Articles and vignettes","title":"pkgdown 1.6.0","text":"build_articles() longer sets theme argument document format NULL as_is: true. allow work wider range output formats including bookdown::html_vignette2() friends (@GegznaV, #955, #1352). build_article() fails, gives complete failure message (#1379). Markdown header attributes now processed markdown files (@jonkeane, #1343)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"auto-linking-and-syntax-highlighting-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Auto-linking and syntax highlighting","title":"pkgdown 1.6.0","text":"branch used source linking can configured setting repo: branch: branch_name _pkgdown.yml (@jonkeane, #1355): autolink_html() (soft) deprecated. Please use downlit::downlit_html_path() instead. Highlighting empty expressions works (#1310). New deploy$install_metadata option _pkgdown.yml. Setting true store site metadata package , allowing offline access packages autolink package’s website (@mstr3336, #1336).","code":"repo:   branch: main"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-6-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Other","title":"pkgdown 1.6.0","text":"can now control background colour plots figures.bg option (transparent default, given white background css). See ?build_reference example. HTML automatically stripped page title (#1318). Suppressing CRAN dates news file now actually works. HTTP requests now retried upon failure (@jameslamb, #1305). Setting clean = TRUE deploy_site_github() removes old files deployed site building new one (#1297).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-151","dir":"Changelog","previous_headings":"","what":"pkgdown 1.5.1","title":"pkgdown 1.5.1","text":"CRAN release: 2020-04-09 Syntax highlighting works Windows (#1282). pkgdown longer fails .Rd files duplicated \\aliases produced older version roxygen2 (#1290). Rendering empty .md file now returns empty string (#1285). build_articles_index() now exported rapidly rebuild index (#1281) deploy_site_github() now accepts host argument specify alternate hosts (e.g., Github enterprise) (@dimagor, #1165) works intended Travis-CI (@jimhester, #1276).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-150","dir":"Changelog","previous_headings":"","what":"pkgdown 1.5.0","title":"pkgdown 1.5.0","text":"CRAN release: 2020-03-25","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-5-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.5.0","text":"articles index page navbar overhauled. two major new features release: articles index page now displays article descriptions, taken YAML metadata belonging article. lets provide context article describe one might want read (#1227). articles navbar now also controlled articles section _pkgdown.yml. ordering sections, articles within , control order articles navbar, can use new navbar field control whether section appears navbar (#1101, #1146). reference index now two levels heading hierarchy: title subtitle (#327). Tables contents sidebars now use bootstrap-toc; considerably improves navigation long articles reference pages. can now control links source files (reference pages articles) issues users (NEWS) new repo$url config option (#1238). makes easier use pkgdown GitHub enterprise, packages subdirectories, source hosts (like bitbucket). individual components (e.g. path, issue number, username) pasted end urls trailing /s. don’t need set links GitLab, pkgdown now detects GitLab urls automatically (since use structure GitHub) (#1045). ’s much richer control Open Graph Twitter metadata whole site individual articles. See new vignette(\"metadata\") details (@gadenbuie, #936). New deploy_to_branch() function build deploy site branch, defaulting gh-pages use GitHub Pages. used recommended GitHub action workflow automatically building deploying pkgdown sites packages GitHub (@jimhester, #1221). Updated JS libraries: jquery 3.3.1 -> 3.4.1; bootswatch 3.3.7 -> 3.4.0; bootstrap 3.3.7 -> bootstrap 3.4.1; docsearch 2.6.1 -> 2.6.3; fontawesome 5.11.1 -> 5.12.1; headroom.js 0.9.44 -> 0.11.0; clipboard.js 2.0.4 -> 2.0.6 (@jayhesselberth).","code":"repo:   url:     home: https://github.com/r-lib/pkgdown/     source: https://github.com/r-lib/pkgdown/blob/main/     issue: https://github.com/r-lib/pkgdown/issues/     user: https://github.com/"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"auto-linking-improvements-1-5-0","dir":"Changelog","previous_headings":"","what":"Auto-linking improvements","title":"pkgdown 1.5.0","text":"Examples Rmd now use exactly syntax highlighting strategy. examples Rmd, calls form current_package::foo now get local link (#1262). \\preformatted{} blocks now highlighted linked parse R code (#1180). library(pkgdown) now automatically linked reference index “pkgdown” documentation library() (#1161). help(\"topic\") now automatically linked documentation “topic”, documentation help() (#1210)","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Articles","title":"pkgdown 1.5.0","text":"build_home() longer uses (unrendered) README.Rmd index.Rmd corresponding .md files found. build_article() failures now print information help debug problem (#952). name vignette mapped “Get started” entry navbar now flexible. can use article (e.g articles/{pkgname}) package . name can replace - generate valid article name (e.g. get started vignette pack.pack-) (#1166).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"deployment-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Deployment","title":"pkgdown 1.5.0","text":"deploy_to_branch() now correctly captures commit SHA GitHub Actions (@coatless, #1252). deploy_to_branch(github_pages = TRUE) generates .nojekyll prevent jekyll ever executing (#1242). CNAME longer generated init_site(), instead conditionally deploy_to_branch() github_pages = TRUE. better fit CNAME file needed GitHub pages (#969). deploy_site_github() argument repo_slug deprecated longer needed used. (@jimhester, #1221)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"news-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"News","title":"pkgdown 1.5.0","text":"See additional details ?build_news: can optionally suppress CRAN release dates added news page (#1118). Multi-page news style gets better yaml specification (old style continue work need change existing YAML).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"reference-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Reference","title":"pkgdown 1.5.0","text":"topic named index longer clobber reference index (#1110). Topic names/aliases reference index now escaped (#1216). build_reference() gives better warnings _pkgdown.yml constructed incorrectly (#1025). New has_keyword() topic selector reference. has_keyword(\"datasets\") particularly useful selecting data documentation (#760). New lacks_concepts() can select topics contain number specified concepts. (@mikldk, #1232)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"home-authors-and-citation-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Home, authors, and citation","title":"pkgdown 1.5.0","text":"pkgdown now escapes html linkifies links comments author info DESCRIPTION (@maelle, #1204) pkgdown now uses ORCiD logo included Font Awesome 5.11 instead querying members.orcid.org (@bisaloo, #1153) badges now extracted everything <!--badges: start--> <!--badges: end-->. used extracted direct children first <p> <!--badges: start-->. build_home() now looks pkgdown/index.md addition top-level index README files (@nteetor, #1031)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"navbar-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Navbar","title":"pkgdown 1.5.0","text":"pkgdown now formats package version displayed navbar way specified DESCRIPTION file. particular, version separators (e.g. . -) preserved. (#1170, @kevinushey) add support navbar submenus: can create submenus following convention established rstudio/rmarkdown#721 (@ijlyttle, @wendtke, #1213)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-5-0","dir":"Changelog","previous_headings":"Minor improvements and bug fixes","what":"Other","title":"pkgdown 1.5.0","text":"Updated JS libraries: jquery 3.3.1 -> 3.4.1; bootswatch 3.3.7 -> 3.4.0; bootstrap 3.3.7 -> bootstrap 3.4.1; docsearch 2.6.1 -> 2.6.3 (@jayhesselberth). Markdown conversion now explicitly allows markdown inside HTML blocks; previously accidentally disabled (#1220). timestamp last site build reported pkgdown.yml (#1122).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-141","dir":"Changelog","previous_headings":"","what":"pkgdown 1.4.1","title":"pkgdown 1.4.1","text":"CRAN release: 2019-09-14 Don’t install test package user library (fixes CRAN failure).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-140","dir":"Changelog","previous_headings":"","what":"pkgdown 1.4.0","title":"pkgdown 1.4.0","text":"CRAN release: 2019-09-03","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-4-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.4.0","text":"build citation specified textVersion argument citEntry CITATION file (#1096, @yiluheihei) build_site(), build_reference() build_home() gain parameter devel controls whether ’re deployment development mode. generalises replaces (deprecation) existing document argument. Development mode optimised rapid iteration default build_reference(). uses pkgload::load_all() load code directly disk order. Deployment mode slower, guarantees correct results, default build_site(). installs package temporary library, runs examples/articles new process. build_reference() longer runs devtools::document() (#1079) build_home() longer re-builds README.Rmd index.Rmd. makes scope responsibility pkgdown clear: now creates/modifies files doc/. build_home() now strips quotes Title Description fields generating page metadata. Additionally, can now override defaults via title description fields home section _pkgdown.yml (#957, @maelle). vignette(\"linking\") describes pkgdown’s automatic linking works, ensure cross-package links point right place.","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"rd-translation-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Rd translation","title":"pkgdown 1.4.0","text":"\\examples{} rendering completely overhauled now first converts entire mixed Rd-R block R prior, evaluates whole thing. considerably improves fidelity translation small cost longer able remove \\donttest{} friends (#1087). \\item{}s \\describe{} containing whitespace translated correctly (#1117). \\dots \\ldots translated ... instead ellipsis, since ’re often found code (#1114). \\tabular{} translation handles code better (@mitchelloharawild, #978). \\subsection{} contents now treated paragraphs, inline text (#991). \\preformatted{} blocks preserve important whitespace (#951).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Front end","title":"pkgdown 1.4.0","text":"Links online documentation functions code chunks longer displayed printing (#1135, @bisaloo). Updated fontawesome v5.7.1. fontawesome 5 deprecated fa prefix. used custom icons navbar, ’ll update (e.g.) fa fa-home fas fa-home. Brands now separate prefix fa fa-github becomes fab fa-github (#953). navbar now automatically hidden headroom.js. sticky behaviour navbar now implemented pure CSS instead relying 3rd party javascript library (#1016, @bisaloo) Favicons now automatically built package logo (#949).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"linking-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Linking","title":"pkgdown 1.4.0","text":"Infix operators (e.g., %% %*%) now linked documentation (#1082). Function names can now included headers without spurious auto-linking (#948). Links external documentation now point rdrr.io (#998).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"other-1-4-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Other","title":"pkgdown 1.4.0","text":"News page recognises version specifications (including “(development version)” now used usethis) (#980). Subdirectories supported assets (#939, @ijlyttle). default 404 page (404.html) built, unless custom .github/404.md provided (#947). build_article() now uses raw vignette title page <title> og:title (@maelle, #1037). build_home() now looks license files spelled either LICENSE LICENCE (#972). build_home() can find badges paragraph coming comment <!-- badges: start --> (#670, @gaborcsardi, @maelle). build_home() add community section sidebar either code conduct (.github/CODE_OF_CONDUCT.md) contributing guide (.github/CONTRIBUTING.md) (#1044, @maelle). build_reference() gains topics argument allows re-build specified topics. build_site(new_process = TRUE) gains timeout, options(pkgdown.timeout = 10), can used prevent stalled builds. deploy_site_github(install = FALSE) makes possible opt installation. dev_mode() now recognises 0.1.9000 development version package (emerging standard use packages backward incompatible changes) (#1101).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-130","dir":"Changelog","previous_headings":"","what":"pkgdown 1.3.0","title":"pkgdown 1.3.0","text":"CRAN release: 2018-12-06 Restore accidentally deleted build_logo() function logos copied website. Fix pkgdown.css page header correct amount top margin. content-home.html template longer used homepage .Rmd (Reverts #834. Fixes #927, #929) deploy_site_github() now passes parameters build_site() (@noamross, #922), documentation gives slightly better advice. Correct --one error navbar highlighting javascript; now navbar highlighted none match current path (#911). Tweaking HTML table classes fixed (@yonicd, #912) Restore accidentally removed docsearch.css file.","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-120","dir":"Changelog","previous_headings":"","what":"pkgdown 1.2.0","title":"pkgdown 1.2.0","text":"CRAN release: 2018-11-20","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-2-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.2.0","text":"deploy_site_github() can used continuous integration systems (like travis) automatically deploy package website GitHub Pages. See documentation set details (@jimhester). build_favicon() creates high resolution favicons package logo, saves pkgdown/. created using https://realfavicongenerator.net/ API, better suited modern web usage (e.g. retina display screens, desktop shortcuts, etc.). also removes dependency magick package, making automated deployment little easier (@bisaloo, #883). Users limited internet connectivity can explicitly disable internet usage pkgdown setting options(pkgdown.internet = FALSE) (#774, #877).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"improvements-to-rd-translation-1-2-0","dir":"Changelog","previous_headings":"","what":"Improvements to Rd translation","title":"pkgdown 1.2.0","text":"rd2html() now exported facilitate creation translation reprexes. \\Sexpr{} conversion supports multiple arguments, eliminating x must string R connection errors using \\doi{} (#738). \\tabular{} conversion better handles empty cells (#780). \\usage{} now supports qualified functions eliminatingError fun_info(x) : Unknown call: :: errors (#795). Invalid tags now generate informative errors (@BarkleyBG, #771, #891)","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-2-0","dir":"Changelog","previous_headings":"","what":"Front end","title":"pkgdown 1.2.0","text":"default footer now displays version pkgdown used build site (#876). third party resources now fetched single CDN give SRI hash (@bisaloo, #893). navbar version now class “version” can easily control display (#680). default css tweaked ensure icons visible browsers (#852).","code":""},{"path":[]},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"home-page-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Home page","title":"pkgdown 1.2.0","text":"Can now build sites older packages don’t Authors@R field (#727). Remote urls ending .md longer tweaked end .html (#763). Bug report link shown ’s “BugReports” field (#855). content-home.html template now used homepage .Rmd (@goldingn, #787). link source inst/CITATION added authors page (#714).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"news-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"News","title":"pkgdown 1.2.0","text":"Uses stricter regular expression linking GitHub authors (#902).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"reference-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Reference","title":"pkgdown 1.2.0","text":"Unexported functions test helpers longer loaded (#789). Selectors match topics now generate warning. none specified selectors match, topics selected (#728).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"articles-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Articles","title":"pkgdown 1.2.0","text":"display depth vignette tables contents can configured setting toc: depth _pkgdown.yml (#821):","code":"toc:   depth: 2"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"overall-site-1-2-0","dir":"Changelog","previous_headings":"Bug fixes and minor improvements","what":"Overall site","title":"pkgdown 1.2.0","text":"init_site() now creates CNAME file one doesn’t already exist site’s metadata includes url field. build_site() loses vestigal mathjax parameter. didn’t appear anything one remember existed (#785). build_site() now uses colours even new_process = TRUE (@jimhester).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-110","dir":"Changelog","previous_headings":"","what":"pkgdown 1.1.0","title":"pkgdown 1.1.0","text":"CRAN release: 2018-06-02","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"new-features-1-1-0","dir":"Changelog","previous_headings":"","what":"New features","title":"pkgdown 1.1.0","text":"build_reference() build_site() get new document argument. TRUE, default, automatically run devtools::document() ensure documentation date. build_site() gains new_process argument, defaults TRUE. run pkgdown separate process, recommended practice improves reproducibility (#647). Improved display icons: icons must 30px stored top-level icons/ directory. embedded separate column reference index table, instead inside comment (!) (#607).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"front-end-1-1-0","dir":"Changelog","previous_headings":"","what":"Front end","title":"pkgdown 1.1.0","text":"Added keyboard shortcut searching. Press shift + / (?) move focus search bar (#642). Algolia logo correctly shown search results (#673). Navbar active tab highlighting uses superior approach (suggested mean active page correctly highlighted scenarios (#660). pkgdown.js better isolated still work even load html widgets import different version jquery (#655).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"improvements-to-rd-translation-1-1-0","dir":"Changelog","previous_headings":"","what":"Improvements to Rd translation","title":"pkgdown 1.1.0","text":"vignette() calls don’t link existing vignettes silently fail link instead generating uninformative error messages (#652). Automatic linking works re-exported objects functions (@gaborcsardi, #666). Empty \\section{}s ignored (#656). Previously, empty sections caused error Error rep(TRUE, length(x) - 1). \\Sexpr{} supports results=text, results=Rd results=hide (#651). \\tabular{} longer requires terminal \\cr (#664, #645).","code":""},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"minor-bug-fixes-and-improvements-1-1-0","dir":"Changelog","previous_headings":"","what":"Minor bug fixes and improvements","title":"pkgdown 1.1.0","text":"Add inst/pkgdown.yml possible site configuration file packages CRAN can built without needing development version (#662). Default navbar template now uses site title, package name (package name default title, affect sites) (#654). can suppress indexing search engines setting noindex: true pkgdown.yml (#686) build_article() sets IN_PKGDOWN env var in_pkgdown() works (#650). build_home(): CITATION files non-UTF-8 encodings (latin1) work correctly, instead generating error. non-UTF-8 locales, ensure e.g. Encoding: latin1 DESCRIPTION; best practice re-enode CITATION file UTF-8 (#689). build_home(): Markdown files (e.g., CODE_OF_CONDUCT.md) stored .github/ copied linked correctly (#682). build_news(): Multi-page changelogs (generated NEWS.md news: one_page: false _pkgdown.yml) rendered correctly. build_reference(): reference index shows infix functions (like %+%) `%+%`, `%+%`() (#659).","code":"template:   params:     noindex: true"},{"path":"https://pkgdown.r-lib.org/dev/news/index.html","id":"pkgdown-100","dir":"Changelog","previous_headings":"","what":"pkgdown 1.0.0","title":"pkgdown 1.0.0","text":"CRAN release: 2018-05-03 Major refactoring path handling. build_ functions longer take path depth arguments. Instead, set destination directory top level pkgdown.yml. Similarly, build_news() longer takes one_page argument; now specified _pkgdown.yml instead. See documentation example.","code":""}]