add subdirs site_generator documentation

R/render_site.R

@@ -111,18 +111,22 @@
 #' }
 #'
 #' A site generation function should return a list with the following elements:
-#' \itemize{
-#'   \item{\code{name}} {The name for the website (e.g. the parent directory
+#' \describe{
+#'   \item{\code{name}:}{The name for the website (e.g. the parent directory
 #'   name).}
-#'   \item{\code{output_dir} {The directory where the website output is written
+#'   \item{\code{output_dir}:}{The directory where the website output is written
 #'   to. This path should be relative to the site directory (e.g. "." or
-#'   "_site")}}
-#'   \item{\code{render}} {An R function that can be called to generate the
+#'   "_site")}
+#'   \item{\code{render}:}{An R function that can be called to generate the
 #'   site. The function should accept the \code{input_file},
 #'   \code{output_format}, \code{envir}, and \code{quiet} arguments.}
-#'   \item{\code{clean}} {An R function that returns relative paths to the files
+#'   \item{\code{clean}:}{An R function that returns relative paths to the files
 #'   generated by \code{render_site} (these files are the ones which will be
 #'   removed by the \code{clean_site} function.}
+#'   \item{\code{subdirs} \emph{(optional)}:}{A logical flag that indicates if
+#'   the generator supports nested source files in subdirectories of the project
+#'   (\code{TRUE}) or only at the project root (\code{FALSE}). (e.g.
+#'   \code{blogdown:::blogdown_site()})}
 #' }
 #'
 #' Note that the \code{input_file} argument will be \code{NULL} when the entire