search

djnavarro / caladown

R package designed to work with the "calade" theme for Hugo
https://caladown.djnavarro.net
Other
26 stars 7 forks source link

readme

The caladown package

Danielle Navarro 11 Jul 2020

Travis build status Lifecycle: experimental CRAN status Codecov test coverage

The goal of caladown is to allow R users to create lightweight websites powered by Hugo and is designed to be compatible with both hugodown and blogdown, and allows users to generate graphics that match the visual style of the site via the thematic package. You can see an example site at:

https://djnavarro.github.io/hugo-calade/

There are two components to caladown, a Hugo theme and an R package. The simplest way to get started is to download the R package from GitHub using the following command:

remotes::install_github("djnavarro/caladown")

Hugodown and blogdown are structured differently, so you must choose which system you wish to use at the outset. If you want to use blogdown, you can create a new site as follows:

caladown::create_blogdown_calade("path_to_blog_folder")

For hugodown, the command is:

caladown::create_hugodown_calade("path_to_blog_folder")

At present these are the only two functions exported by the caladown package (documentation is here, but very minimal at the moment). For more information, it is probably best to look at the tutorial section of the example site.