build_home: Build a home page for a lesson

In zkamvar/sandpaper: Create and Curate Carpentries Lessons

Build a home page for a lesson

Description

Build a home page for a lesson

Usage

build_home(pkg, quiet, next_page = NULL)

Arguments

pkg	a list generated from pkgdown::as_pkgdown() from the ⁠site/⁠ folder of a lesson.
quiet	a boolean passed to build_html(). if TRUE, this will have pkgdown report what files are being built
next_page	the next page file name. This will allow the navigation element to be set up correctly on the navigation bar

Details

The index page of the lesson is a combination of two pages:

1. index.md (or README if the index does not exist)

2. learners/setup.md

This function uses render_html() to convert the page into HTML, which gets passed on to the "syllabus" or "overview" templates in {varnish} (via the build_html() function as the {{{ readme }}} and {{{ setup }}} keys.

Value

nothing. This is used for its side-effect

zkamvar/sandpaper documentation built on Feb. 2, 2025, 5:17 p.m.