Configure vignette toc depth

NEWS.md

@@ -1,5 +1,12 @@
 # pkgdown 1.1.0.9000
 
+* The display depth of vignette tables of contents can be configured by setting `toc: depth` in `_pkgdown.yml`:
+
+  ```yaml
+  toc:
+    depth: 2
+  ```
+
 * `build_site()` now uses colors even if `new_process = TRUE` (@jimhester).
 
 * `deploy_site_github()` added to build and deploy a site to GitHub Pages from the

R/build-articles.R

@@ -97,6 +97,14 @@
 #' to enable rendering of [bookdown](https://bookdown.org/yihui/bookdown/)
 #' sites.
 #'
+#' @section Tables of contents:
+#' You can control the TOC depth via the YAML configuration file:
+#'
+#' ```
+#' toc:
+#'   depth: 2
+#' ```
+#'
 #' @inheritParams as_pkgdown
 #' @param quiet Set to `FALSE` to display output of knitr and
 #'   pandoc. This is useful when debugging.
@@ -215,7 +223,7 @@ build_rmarkdown_format <- function(pkg,
 
   out <- rmarkdown::html_document(
     toc = toc,
-    toc_depth = 2,
+    toc_depth = pkg$meta$toc$depth %||% 2,
     self_contained = FALSE,
     theme = NULL,
     template = template$path