jekyll: Jekyll folder structure

Description Usage Arguments

Description

Create a jekyll site structure from a package's roxygen. Optionally, a site may be built, too. Building your site requires jekyll to be installed and available on your system.

Usage

1
jekyll(path = ".", dir = "docs", build = TRUE, assets = NULL)

Arguments

path

A file path specifying the folder of a package, defaults to ".".

dir

A file path, relative to path, specifying the destination of the jekyll folders and files, defaults to "docs/".

build

One of TRUE or FALSE specifying if the jekyll site is built after creating the folder structure, defaults to FALSE.

assets

A character vector specifying file paths of assets to include in the jekyll assets folder. Javascript files are sorted into assets/js/, CSS files are sorted into assets/css, and all other files are put directly into assets/.


nteetor/hyderogen documentation built on June 1, 2019, 9:13 p.m.