buildBook: Build a Book without Underscores

In Orcs: Omnidirectional R Code Snippets

Build a Book without Underscores

Description

Since the use of underscores ('_') is not permitted when streaming bookdown documents via GitHub Pages, this wrapper function serves to remove any unwanted underscores from subfolders and link .html documents created by bookdown::render_book().

Usage

buildBook(output_dir = "book", ...)

Arguments

output_dir	Output directory as character.
...	Arguments passed to bookdown::render_book().

Note

While all remaining arguments passed to bookdown::render_book() remain untouched, and hence their specification is freely up to the user, the default value of 'output_dir' is explicitly set to "book" here. If this were not the case (i.e. if the default value were used), the output document would be created in "_book" which is not desirable for obvious reasons.

Author(s)

Florian Detsch

Orcs documentation built on Jan. 6, 2023, 5:14 p.m.