Function reference • pkgdown

Build

Build a complete site or one of its components.

build_site(): Build a complete pkgdown website

build_articles() build_article() build_articles_index(): Build articles section

build_favicons(): Create favicons from package logo

build_home_index() build_home(): Build home section

build_news(): Build news section

build_tutorials(): Build tutorials section

build_reference() build_reference_index(): Build reference section

build_search(): Build search index

init_site(): Initialise site infrastructure

preview_site(): Open site in browser

pkgdown_sitrep(): Report package pkgdown situation

Deployment

deploy_to_branch(): Build and deploy a site locally

build_site_github_pages(): Build site for GitHub pages

check_pkgdown(): Check _pkgdown.yml

Templates

template_navbar() template_reference() template_articles(): Generate YAML templates

render_page() data_template(): Render page with template

Helpers

clean_site(): Clean site

rd2html(): Translate an Rd string to its HTML output

as_pkgdown(): Generate pkgdown data structure

in_pkgdown(): Determine if code is executed by pkgdown

Regression tests

index test-index: Index

test-crayon: Test case: crayon

test-dont: Test case: don't

test-figures: Test case: figures

test-links: Test case: links

test-lists: Test case: lists

test-long-lines: Test case: long-lines

test-output-styles: Test case: output styles

test-params: Test case: params

test-sexpr-title: Test case: sexpr

test-verbatim: Test case: preformatted blocks & syntax highlighting