add_to_bookdown: Add webexercises helper files to bookdown

View source: R/add_to_bookdown.R

add_to_bookdownR Documentation

Add webexercises helper files to bookdown

Description

Adds the necessary helper files to an existing bookdown project and edits the _output.yml and _bookdown.yml files accordingly. If the directory does not have a bookdown project in it, a template project will be set up.

Usage

add_to_bookdown(
  bookdown_dir = ".",
  include_dir = "include",
  script_dir = "R",
  output_format = c("bs4_book", "gitbook", "html_book", "tufte_html_book"),
  render = FALSE
)

Arguments

bookdown_dir

The base directory for your bookdown project

include_dir

The directory where you want to put the css and js files (defaults to "include")

script_dir

The directory where you want to put the .R script (defaults to "R")

output_format

The bookdown format you want to add webexercises to (defaults to "bs4_book") This is typically your default HTML format in the _output.yml file.

render

Whether to render the book after updating (defaults to FALSE).

Value

No return value, called for side effects.


webexercises documentation built on May 31, 2023, 8:16 p.m.