Package index • pkgdown

"

Build

Build the complete site

build_site(): Build a complete pkgdown website
clean_site() clean_cache(): Clean site
preview_site(): Open site in browser
check_pkgdown() pkgdown_sitrep(): Check _pkgdown.yml

Build part of a site

These functions are useful for rapid iteration when you’re working on a specific part of your site.

build_articles() build_article() build_articles_index(): Build articles section
build_home() build_home_index(): Build home section
build_llm_docs(): Build docs for LLMs
build_news(): Build news section
build_reference() build_reference_index(): Build reference section
build_tutorials(): Build tutorials section
build_search(): Build search index
build_redirects(): Build redirects
init_site(): Initialise site infrastructure

Customisation

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

For expert use

Deployment

deploy_to_branch(): Build and deploy a site locally
build_site_github_pages(): Build site for GitHub pages

Other helpers

rd2html(): Translate an Rd string to its HTML output
as_pkgdown(): Generate pkgdown data structure
in_pkgdown(): Determine if code is executed by pkgdown
render_page() data_template(): Render page with template
build_favicons(): Initialise favicons from package logo

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-math-examples: Test case: math rendering in examples
test-output-styles: Test case: output styles
test-params: Test case: params
test-sexpr-title: Test case: sexpr
test-tables: Test case: tables
test-verbatim: Test case: preformatted blocks & syntax highlighting

Deprecated functions

autolink_html() deprecated: Automatically link references and articles in an HTML page
preview_page() deprecated: Preview a local pkgdown page in the browser