build_404: Build the 404 page for a lesson

View source: R/build_404.R

build_404R Documentation

Build the 404 page for a lesson

Description

Build the 404 page for a lesson

Usage

build_404(pkg, quiet = FALSE)

Arguments

pkg

a list object generated from pkgdown::as_pkgdown()

quiet

passed to build_html(). When FALSE (default), a message will be printed to the screen about the build progress. When TRUE, no messages are generated.

Details

During the lesson build process, a 404 page with absolute links back to the source pages must be generated otherwise, subsequent attempts to escape the 404 page will be futile.

This function is intended to be run on a lesson website that has already been built and is called for its side-effect of creating a 404 page.

Value

TRUE if the page was successfully generated

See Also

build_site() which calls this function and build_html(), which this function calls.


zkamvar/sandpaper documentation built on May 11, 2024, 7:26 a.m.