Package index • bookdown

Book output formats

These output formats are for building books from single or multiple .Rmd documents. They are built with render_book().

gitbook(): The GitBook output format

pdf_book(): Convert R Markdown to a PDF book

epub_book(): The EPUB e-book format

bs4_book() bs4_book_theme(): HTML book built with bootstrap4

html_chapters() html_book() tufte_html_book(): Build book chapters into separate HTML files

Single document output formats

These output formats enable bookdown’s special features like cross references in single .Rmd documents instead of books. There are built with rmarkdown::render().

html_document2() html_fragment2() html_notebook2() html_vignette2() ioslides_presentation2() slidy_presentation2() tufte_html2() pdf_document2() beamer_presentation2() tufte_handout2() tufte_book2() markdown_document2() context_document2() github_document2() odt_document2() powerpoint_presentation2() rtf_document2() word_document2(): Output formats that allow numbering and cross-referencing figures/tables/equations

Create a book

create_gitbook() create_bs4_book(): Create a bookdown project

Previewing and rendering books

render_book() preview_chapter(): Render multiple R Markdown documents into a book

serve_book(): Continuously preview the HTML output of a book using the servr package

Publishing books

Publish books on https://bookdown.org or elsewhere.

publish_book(): Publish a book to the web

Helper functions

These functions are utility functions when working with bookdown.

clean_book(): Clean up the output files and directories from the book

bookdown_site(): R Markdown site generator for bookdown

fence_theorems(): Convert the syntax of theorem and proof environments from code blocks to fenced Divs

calibre(): A wrapper function to convert e-books using Calibre