init_site: Initialise the site

Description Usage Arguments Custom CSS/JS Favicon

View source: R/init.R

Description

This creates the output directory, creates favicon.ico from package logo, creates a machine readable description of the site, and sets up assets and extra files.

Usage

1
init_site(pkg = ".")

Arguments

pkg

Path to package.

Custom CSS/JS

If you want to do minor customisation of your pkgdown site, the easiest way is to add pkgdown/extra.css and pkgdown/extra.js. These will be automatically copied to docs/ and inserted into the <HEAD> after the default pkgdown CSS and JSS.

Favicon

If you include you package logo in the standard location of man/figures/logo.png, a favicon will be automatically created for you.


jayhesselberth/pkgdown-search documentation built on May 17, 2019, 9:12 a.m.