Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

pkgdown

Make Static HTML Documentation for a Package

Generate an attractive and useful website from a source package. 'pkgdown' converts your documentation, vignettes, 'README', and more to 'HTML' making it easy to share information about your package online.

Functions (29)

as_pkgdown

Generate pkgdown data structure

autolink_html

Automatically link references and articles in an HTML page

build_articles

Build articles section

build_favicons

Create favicons from package logo

build_home

Build home section

build_news

Build news section

build_reference

Build reference section

build_site

Build a complete pkgdown website

build_tutorials

Build tutorials section

clean_site

Clean site

deploy_site_github

Deploy a pkgdown site on Travis-CI to Github Pages

deploy_to_branch

Build and deploy a site locally

in_pkgdown

Determine if code is executed by pkgdown

index

Index

init_site

Initialise site infrastructure

pkgdown-package

pkgdown: Make Static HTML Documentation for a Package

preview_site

Open site in browser

rd2html

Translate an Rd string to its HTML output

render_page

Render page with template

templates

Generate YAML templates

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-output-styles

Test case: output styles

test-params

Test case: params

test-sexpr-title

Test case: sexpr

test-verbatim

Test case: verbatim blocks

pkgdown

Make Static HTML Documentation for a Package

v1.6.1

MIT + file LICENSE

Authors

Hadley Wickham [aut, cre] (<https://orcid.org/0000-0003-4757-117X>), Jay Hesselberth [aut] (<https://orcid.org/0000-0002-6299-179X>), RStudio [cph, fnd]

Initial release

pkgdown

Functions (29)

pkgdown

We don't support your browser anymore