The {govukhugo} package provides functions to use R Markdown files with the govuk-hugo theme for Hugo.
govuk-hugo is a theme that brings the GOV.UK design system to the Hugo static site builder. Hugo is used by blogdown, however govuk-hugo is not compatible with blogdown's processes for rendering Rmd files, hence the functions within the {govukhugo} package.
Online documentation is provided in the cross-package govuk-hugo-demo site.
Note that both the {govukhugo} package and the govuk-hugo theme are still experimental works in progress, it should work on *nix (Mac/Linux) systems but has not yet been tested on Windows builds. Extreme caution is advised.
You can install {govukhugo} as follows:
remotes::install_github("co-analysis/govukhugo")There are two main functions:
init_govuk_hugo()- this creates the scaffold of a hugo site with thegovuk-hugotheme.build_hugo()- this will render Rmd files and run hugo's site building
Where possible it is recommended that plain markdown files (.md) are used - i.e. if there is no R content in a page then create it as a plain markdown file. These should be stored within the content folder. It is also recommended that all sections (i.e. subfolders within content) should have their own _index.md file, see the govuk-hugo documentation for more details.
It is recommended that Rmd files are stored in an R/Rmd folder. This is the default folder that build_hugo() looks in for .Rmd files, it will also search any sub-directories.
Rmd files for govuk-hugo should have simple YAML headers:
---
title: My R Markdown file
date: 2021-01-28
section: section
---
section should be the sub-folder of the content directory that you want build_govuk_hugo() to render the Rmd file into.
More detailed documentation on working with R Markdown files is provided in the cross-package govuk-hugo documentation, along with tests of [static] and interactive R Markdown files.