bs4_book {bookdown}R Documentation

HTML book built with bootstrap4

Description

This output format is built with bootstrap, using carefully craft features to provide a clean reading experience whether your on a phone, tablet, or desktop.

Some of the main features:

This theme is designed for books that use one chapter per page.

Usage

bs4_book(
  theme = bs4_book_theme(),
  repo = NULL,
  ...,
  lib_dir = "libs",
  pandoc_args = NULL,
  extra_dependencies = NULL
)

bs4_book_theme(primary = "#0068D9", ...)

Arguments

theme

A named list or bslib::bs_theme() object. The default, bs4_book_theme(), resets the base font size to 1rem to make reading easier and uses a primary colour with greater constrast against the background.

repo

Link to repository where book is hosted, used to generate view source and edit buttons. Currently assumes GitHub and that the book is in the root directory of the repo.

lib_dir, pandoc_args, extra_dependencies, ...

Passed on to rmarkdown::html_document().

primary

Primary colour: used for links and background of footer.


[Package bookdown version 0.22 Index]