bookdown Documentation

Technical Documentation: rstudio/bookdown

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

bookdown [](https://pkgs.rstudio.com/bookdown/)

A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Features include:

• Generate printer-ready books and ebooks from R Markdown documents
• A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations
• Multiple choices of output formats: PDF, LaTeX, HTML, EPUB, and Word.
• Possibility of including dynamic graphics and interactive applications (HTML widgets and Shiny apps)
• Support for languages other than R, including C/C++, Python, and SQL, etc.
• LaTeX equations, theorems, and proofs work for all output formats
• Can be published to GitHub, bookdown.org, and any web servers
• Integrated with the RStudio IDE
• One-click publishing to Posit Connect

Book Copy Chapter

Installation Copy Chapter

You can install the package from CRAN as follows:

install.packages("bookdown")

If you want to use the development version of the bookdown package, you can install the package from GitHub via the pak package:

# install.packages("pak")
pak::pak('rstudio/bookdown')

Usage Copy Chapter

The easiest way to start a new Bookdown project is from within RStudio IDE. Go to File > New Project > New Directory > Book project using bookdown.

This will create a new directory with an example book as template. You can build the HTML version of this example book without doing any modification:

• Go into the Build Pane in the RStudio IDE
• Click on Build Book > bookdown::gitbook

You can also run bookdown::render_book() in the R console.

Learn more about using bookdown in the Getting started section.

Getting help Copy Chapter

There are two main places to get help:

1. The RStudio community is a friendly place to ask any questions about bookdown. Be sure to use the bookdown tag.

2. Stack Overflow is a great source of answers to common bookdown questions. Use the tags [r][bookdown] if you ask a question.

Code of Conduct Copy Chapter

Please note that the bookdown project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Overview (`inst/homepage/readme.md`) Copy Section

The source documents for the bookdown.org homepage has been moved to https://github.com/rstudio/bookdown.org.

Overview (`tests/manual/README.md`) Copy Section

Manual tests

This folder contains Rmd files useful for visual inspecteion of some features

Overview (`inst/rstudio/templates/project/resources/common/README.md`) Copy Section

Welcome!

This is a minimal example of a book based on R Markdown and bookdown (https://github.com/rstudio/bookdown).

This template provides a skeleton file structure that you can edit to create your book.

The contents inside the .Rmd files provide some pointers to help you get started, but feel free to also delete the content in each file and start fresh.

Additional resources:

The bookdown book: https://pkg.yihui.org/bookdown/

The bookdown package reference site: https://pkgs.rstudio.com/bookdown

--- METRICS ---

• Files Extracted: 4
• Estimated Token Budget: ~980 tokens
• Canonical Reference: https://codewiki.google/github.com/rstudio/bookdown