gitbook: The GitBook output format

Description Usage Arguments

View source: R/gitbook.R


This output format function ported a style provided by GitBook ( for R Markdown.


gitbook(fig_caption = TRUE, number_sections = TRUE, self_contained = FALSE, 
    lib_dir = "libs", pandoc_args = NULL, ..., split_by = c("chapter", "chapter+number", 
        "section", "section+number", "rmd", "none"), split_bib = TRUE, config = list())


fig_caption, number_sections, self_contained, lib_dir, pandoc_args

... Arguments to be passed to rmarkdown::html_document() (... not including toc, theme, and template).


Other arguments to be passed to base_format. For html_book() and tufte_html_book(), ... is passed to html_chapters().


How to name the HTML output files from the book: rmd uses the base filenames of the input Rmd files to create the HTML filenames, e.g. generate ‘chapter1.html’ for ‘chapter1.Rmd’; none means do not split the HTML file (the book will be a single HTML file); chapter means split the file by the first-level headers; section means the second-level headers. For chapter and section, the HTML filenames will be determined by the header ID's, e.g. the filename for the first chapter with a chapter title # Introduction will be ‘introduction.html’; for chapter+number and section+number, the chapter/section numbers will be prepended to the HTML filenames, e.g. ‘1-introduction.html’ and ‘2-1-literature.html’.


Whether to split the bibliography onto separate pages where the citations are actually used.


A list of configuration options for the gitbook style, such as the font/theme settings.

bookdown documentation built on Feb. 18, 2018, 5:01 p.m.