Minor documentation fixes and review.

R/config.R

@@ -1,3 +1,5 @@
+#' Gallery site configuration
+#'
 #' Site configuration for the [gallery_site()] generator.
 #'
 #' @inheritParams rmarkdown::site_config

R/gallery_site_generator.R

@@ -1,7 +1,12 @@
 # rmarkdown/R/render_site.R ----
 # https://github.com/rstudio/rmarkdown/blob/947b87259333b43f47b5f59e91dc9a1ea10d1c4d/R/render_site.R
 
-#' Gallery website generator.
+#' Gallery website generator
+#'
+#' Define a custom website generator to be used with [rmarkdown::render_site()].
+#' This generates a simple R Markdown website including a gallery of pages with
+#' embedded content, based on metadata in JSON format and custom site
+#' configuration options.
 #'
 #' @inheritParams rmarkdown::default_site_generator
 #'

R/templates.R

@@ -17,7 +17,6 @@ gallery_div <- function(class, content) {
 #' Create the content of a gallery page based on arbitrary page content and
 #' gallery configuration.
 #'
-#'
 #' @param ... Unnamed items defining the main content of the page.
 #' @param gallery_config The gallery site configuration. Elements
 #'   `$include_before` and `$include_after` (if present) are included before and
@@ -43,12 +42,12 @@ gallery_div <- function(class, content) {
 #' @examples
 #' gallery_content(
 #'   htmltools::h2("Hello world"),
-#'   "Welcome to the callery content world",
+#'   "Welcome to the gallery content world",
 #'   gallery_config = list(
 #'     include_before = "before<hr/>",
 #'     include_after = htmltools::tagList(htmltools::hr(), "after")
 #'   ),
-#'   class = "hello-gallery-content"
+#'   class = "hello-gallery"
 #' )
 #'
 #' @export