buildBook: Build a Book without Underscores

Description Usage Arguments Note Author(s) See Also

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 render_book.

Usage

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

Arguments

output_dir

Output directory as character.

...

Arguments passed to render_book.

Note

While all remaining arguments passed to 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

See Also

render_book.


Orcs documentation built on May 2, 2019, 2:37 a.m.