Open-source project
rstudio/bookdown avatar
rstudio/bookdown

The package is R and the repository record calls it JavaScript

Authoring Books and Technical Documents with R Markdown

4,095 stars1,280 forksJavaScriptGPL-3.0

At a glance

What is it?
bookdown turns R Markdown into books and long-form reports in PDF, LaTeX, HTML, EPUB and Word, and its whole getting started path is one IDE wizard plus one build target. The gaps are in the metadata and in the silence: a language detection that does not match the package, and a readme that never mentions the test suite.
Who is it for?
bookdown fits a team that already writes in R Markdown and needs a book out of it, because the output formats, the cross-language code support and the IDE integration are the reasons to pick it. Two things to check before you commit.
Can I use it commercially?
Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
Is it still maintained?
Yes. The repository last received commits 58 days ago.
What is it written in?
Mainly JavaScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • rstudio/bookdown4,095 ★ · +18
Star history
Repository2026-09-242026-11-15
rstudio/bookdown4.1k4.1k

18 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

An R package whose repository language is recorded as JavaScript

The repository record for this project lists its primary language as JavaScript. Everything in the tree says otherwise.

The top level is the standard shape of an R package: `DESCRIPTION` carrying the metadata, `NAMESPACE` for exports, `R/` for the source, `man/` for the manual pages, `inst/` for installed files, `tests/`, `tools/`, `vignettes/` and `NEWS.md`, plus `.Rbuildignore` which tells the build what to leave out. There is no JavaScript source directory in that list.

That matters more for an R package than a stray classification would for a script library, because the language field is one of the first things a package index and a search engine read. A package index that files an R package under JavaScript will rank it for the wrong audience, and an automated dependency tool reading the same field will draw the wrong conclusion about what pulls it in.

The one entry that is neither R package convention nor documentation is `bookdown.Rproj`, the RStudio project file, which is what makes the IDE integration described later a real integration rather than a claim.

Getting started is one wizard, one example book, one build target

The usage section is unusually short, and every step in it is an IDE action rather than a command.

From the RStudio IDE you choose File, then New Project, then New Directory, then the Book project using bookdown entry. That creates a new directory containing an example book as a template, and the point of the template is that it builds without modification. You then go to the Build pane and click Build Book, choosing `bookdown::gitbook`, which produces the HTML version.

There is exactly one command in the whole readme for doing that outside the IDE, and it is `bookdown::render_book()` in the R console. So the documented build path is one R function plus one menu target, and the format is chosen by which build target you pick rather than by an argument.

The readme then sends you to a getting started article on the package site, which is the right place to go next since the visible page stops at the first build.

Two install routes, one of them through pak

The released package comes from CRAN:

``` r install.packages("bookdown")

code

The development version comes from GitHub, and the mechanism is the pak package rather than a direct git call:

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

So a contributor needs two packages installed before they can build from source, and the second line of that block is commented out, which is the readme's way of saying it is a prerequisite rather than part of the command.

Worth noting that the repository identifier used for the install is the owner and name pair, not a URL, and that it is spelled with a capital R in the owner. That is the form pak expects, and it is a small convenience that the readme does not explain further.

For anyone on a machine without CRAN configured, the second block is the only route in this page, so it carries more weight than its two lines suggest.

Publishing is the feature with three targets and one more

The feature list is nine items and three of them are about output rather than authoring.

The formats are PDF, LaTeX, HTML, EPUB and Word, from the same source. Alongside that, LaTeX equations, theorems and proofs are stated to work for all output formats, which is the claim that matters if your material is mathematical, and the markup language is described as easier to learn than LaTeX for headers, lists, quotes, figures, tables and citations.

Two items extend past the document itself. Dynamic content can be included, naming HTML widgets and Shiny apps. And languages other than R are supported for code, naming C and C++, Python and SQL among them.

The publishing line is the interesting one: the package can publish to GitHub, to bookdown.org, and to any web servers. A separate item adds one click publishing to Posit Connect. So there are four destinations named, and only one of them is someone else's hosting.

The branding in the page mixes eras, with the package site on an RStudio URL and a Posit forum link, both of which are current names for what was once one company.

Help is a forum tag and a Stack Overflow tag

Two places are named for questions, and neither is the repository.

The first is the RStudio community forum, now hosted at forum.posit.co, with a dedicated tag for the package and an explicit instruction to use it. The second is Stack Overflow, with the paired tags for the language and the package.

What is not named is the issue tracker, even though `.github/` is in the tree, and no discussion area is offered either. The readme's position is that questions go to other people and defects go wherever the project's own process says, which is left unstated.

The conduct section is the other policy in the page. The project ships with a contributor code of conduct, and the terms are framed as a condition: by contributing you agree to abide by them.

That makes the page's policy coverage uneven in an instructive way. There is a code of conduct and a licence, and there is no stated bug reporting route, no security contact and no support policy for anyone using the package without contributing to it.

The project's own site is built with pkgdown, and the readme does not say so

The tree shows how the documentation site is produced. There is a `_pkgdown.yml` configuration file at the root and a `pkgdown/` directory beside it, which is the layout of a site built with pkgdown, the same family of tools the package itself belongs to. There is also `codecov.yml`, so coverage is measured, and a `CHANGELOG` equivalent in `NEWS.md`.

None of that appears in the readme. The page never mentions the test suite under `tests/`, the manual pages under `man/`, the vignettes, or the changelog. It links to a getting started article on the package site instead, which means the generated manual pages are the real reference and the readme is the entry point to them.

The vignettes directory is worth a second look for a different reason. A package that ships vignettes has decided which workflows are worth teaching in full, and a book about writing books is the obvious candidate: the page links to one, hosted at `pkg.yihui.org/bookdown/`, rather than hosting the book inside this repository.

So the documentation strategy is spread across three places: this readme for orientation, the generated manual for reference, and an externally hosted book for the long form material.

Still version 0.48, with six months between two tags

The version history explains the caution in the packaging. The three newest tags are v0.46 on 2025-12-05, v0.47 on 2026-06-16 and v0.48 on 2026-08-28.

So the package is many years old and still below 1.0, and the cadence is irregular: a six and a half month gap between 0.46 and 0.47, then a gap of two and a half months to 0.48. A project on a 0.x line with gaps like that gives you two practical constraints. Pin the version in anything you intend to rebuild, and read the notes when you move between minors rather than assuming only additions.

The release naming is inconsistent in a small way too: one of the three is titled with a v inside the name and the other two are not, which matters if anything downstream parses those titles.

The default branch is `main` and it was last pushed on 2026-09-18, so the branch tip is a few weeks ahead of the newest tag. The package is GPL-3, with the licence file at the root of the repository named `LICENSE.txt` rather than `LICENSE`, which is the conventional name inside an R package tarball.

Editorial conclusion

bookdown fits a team that already writes in R Markdown and needs a book out of it, because the output formats, the cross-language code support and the IDE integration are the reasons to pick it. Two things to check before you commit. It is still on version 0.48, so expect the API to move between minor versions, and read the release notes rather than assuming a stable surface. And decide your publishing target early: the package pushes to GitHub, to bookdown.org or to any web server, and adds one click publishing to Posit Connect, which are three different pieces of infrastructure to own.

Frequently asked questions

What is bookdown?

An open source GPL-3 R package for writing books and long-form articles and reports with R Markdown. It produces printer-ready books and ebooks in PDF, LaTeX, HTML, EPUB and Word, and can include HTML widgets and Shiny apps.

How do I use bookdown to start a book?

From the RStudio IDE choose File, New Project, New Directory, then Book project using bookdown, which creates a directory with an example book template. Build it with Build Book and the bookdown::gitbook target, or run bookdown::render_book() in the console.

How do I install bookdown?

From CRAN with install.packages("bookdown"). The development version is installed from GitHub through the pak package, with pak::pak('rstudio/bookdown').

How does bookdown compare with Quarto?

The readme does not discuss Quarto or any other alternative. It lists the output formats bookdown produces and points to the RStudio community forum and Stack Overflow for questions.

Which licence does bookdown use?

GPL-3, named in the readme and recorded in the LICENSE.txt file at the root of the repository.

Official sources

  1. License: GPL-3.0
  2. Project website
  3. README
  4. Releases
  5. rstudio/bookdown on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/rstudio-bookdown.svg)](https://hysenlabs.com/projects/rstudio-bookdown)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/rstudio-bookdown.svg)](https://hysenlabs.com/projects/rstudio-bookdown)

Was this useful?