README.md

In pbreheny/html: Functions for creating HTML reports

Helper/convenience functions for rmd -> html rendering

Install

remotes::install_github("pbreheny/html")

Overview

The html package has two purposes:

• To provide simple, command-line-friendly methods for rendering Rmarkdown files into html (turning a.rmd into a.html)
• To provide convenience functions for setting up things like footers, icons, buttons, etc.

The underlying rendering is done by the rmarkdown package, but html handles input/output directories in a sensible way (at least, in a way that I find sensible) such that it can simply be called with a single argument (the file to render) from the package root and everything will be taken care of automatically.

Rendering

The package is set up for three specific use cases:

1. Single .rmd file: For simple projects that consist of a single Rmarkdown file,

html::render_page('page.rmd')

This creates page.html in the same directory as page.rmd. If there are multiple .rmd files in the same directory, it quickly becomes very disorganized to have both .rmd pages and .html pages in the same directory, so render_page() will throw an error in these situations. This can be turned off with force=TRUE.

1. GitHub pages: GitHub pages expects that html documents are located in a directory called docs. If this directory exists, then the rendered .html file appears there instead:

html::render_page('page.rmd')

This creates the file /docs/page.html if the docs folder exists.

1. Jekyll: The expectation here is that the .rmd files are in a folder called web and the rendered html will appear in a folder called web/_site, which will then be hosted locally or by some service provider:

html::render_page('web/page.rmd')

This creates the file web/_site/page.html. Note that in this case, the .rmd file is located in a web subdirectory, but all code (both the call to render_page() and all code in the .rmd file) is run from the project's root directory.

Batch usage

To render a bunch of files:

html::render_all()

If a web directory exists, this renders all the .rmd files in it; otherwise it renders all the files in the project root. One can also supply a list of files to render. This is essentially a wrapper to render_page, but (a) with quieter output and (b) by default, cleans out old .html files from the destination before repopulating it.

pbreheny/html documentation built on April 17, 2025, 11:36 p.m.