Make Static HTML Documentation for a Package
Generate pkgdown data structure
Automatically link references and articles in an HTML page
Build articles section
Initialise favicons from package logo
Build home section
Build news section
Build redirects
Build reference section
Build search index
Build site for GitHub pages
Build a complete pkgdown website
Build tutorials section
Check _pkgdown.yml
Clean site
Deploy a pkgdown site on Travis-CI to Github Pages
Build and deploy a site locally
Get current settings for figures
Determine if code is executed by pkgdown
Index
Initialise site infrastructure
Print object in pkgdown output
pkgdown: Make Static HTML Documentation for a Package
Preview a local pkgdown page in the browser
Open site in browser
Translate an Rd string to its HTML output
Render page with template
Generate YAML templates
Test case: crayon
Test case: don't
Test case: figures
Test case: links
Test case: lists
Test case: long-lines
Test case: output styles
Test case: params
Test case: "sexpr"
Test case: tables
Test case: preformatted blocks & syntax highlighting
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.
Useful links